{ "openapi": "3.0.1", "info": { "title": "Buddy API", "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" }, "version": "1.2" }, "tags": [ { "name": "Domains API", "description": "Manage records for your workspace domains" }, { "name": "OAuth 2.0", "description": "Token issuance and revocation endpoints" } ], "paths": { "/oauth2/register": { "post": { "tags": [ "OAuth 2.0" ], "summary": "Register a new OAuth 2.0 client", "operationId": "registerClient", "requestBody": { "description": "Client registration request", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DynamicClientRegistrationResponse" }, "example": { "client_id": "123-api-buddy-client", "client_secret": "cf136dc3c697097915ed7f4a70d1f1a", "registration_access_token": "this.is.a.registration.access.token", "registration_client_uri": "https://api.buddy.works/oauth2/register/123-api-buddy-client", "client_id_issued_at": 1675123456, "client_secret_expires_at": 0, "client_name": "My Application", "redirect_uris": [ "https://client.example.org/callback" ], "grant_types": [ "authorization_code", "refresh_token", "client_credentials" ], "response_types": [ "code" ], "token_endpoint_auth_method": "client_secret_basic", "client_uri": "https://client.example.org", "description": "My OAuth 2.0 application", "token_expires_in": 3600 } } } }, "400": { "description": "Invalid request - missing or invalid parameters" }, "401": { "description": "Unauthorized - invalid or missing authentication" } } } }, "/oauth2/register/{client_id}": { "get": { "tags": [ "OAuth 2.0" ], "summary": "Read client configuration", "operationId": "getClientConfiguration", "parameters": [ { "name": "client_id", "in": "path", "description": "Client identifier", "required": true, "schema": { "type": "string", "example": "123-api-buddy-client" } }, { "name": "Authorization", "in": "header", "description": "Bearer {registration_access_token}", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DynamicClientRegistrationResponse" }, "example": { "client_id": "123-api-buddy-client", "registration_client_uri": "https://api.buddy.works/oauth2/register/123-api-buddy-client", "client_id_issued_at": 1675123456, "client_secret_expires_at": 0, "client_name": "My Application", "redirect_uris": [ "https://client.example.org/callback" ], "grant_types": [ "authorization_code", "refresh_token", "client_credentials" ], "response_types": [ "code" ], "token_endpoint_auth_method": "client_secret_basic", "client_uri": "https://client.example.org", "description": "My OAuth 2.0 application", "token_expires_in": 3600 } } } }, "401": { "description": "Unauthorized - invalid registration access token" }, "404": { "description": "Client not found" } } }, "delete": { "tags": [ "OAuth 2.0" ], "summary": "Delete client", "operationId": "deleteClient", "parameters": [ { "name": "client_id", "in": "path", "description": "Client identifier", "required": true, "schema": { "type": "string", "example": "123-api-buddy-client" } }, { "name": "Authorization", "in": "header", "description": "Bearer {registration_access_token}", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Client successfully deleted" }, "401": { "description": "Unauthorized - invalid registration access token" }, "404": { "description": "Client not found" } }, "security": [ { "BearerAuth": [] } ] }, "patch": { "tags": [ "OAuth 2.0" ], "summary": "Update client configuration", "operationId": "updateClientConfiguration", "parameters": [ { "name": "client_id", "in": "path", "description": "Client identifier", "required": true, "schema": { "type": "string", "example": "123-api-buddy-client" } }, { "name": "Authorization", "in": "header", "description": "Bearer {registration_access_token}", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Updated client configuration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DynamicClientRegistrationRequest" }, "example": { "client_name": "Updated Application Name", "redirect_uris": [ "https://client.example.org/callback", "https://client.example.org/callback2" ], "grant_types": [ "authorization_code", "refresh_token" ], "response_types": [ "code" ], "token_endpoint_auth_method": "client_secret_basic", "client_uri": "https://client.example.org", "description": "Updated OAuth 2.0 application description", "token_expires_in": 7200 } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DynamicClientRegistrationResponse" }, "example": { "client_id": "123-api-buddy-client", "registration_client_uri": "https://api.buddy.works/oauth2/register/123-api-buddy-client", "client_id_issued_at": 1675123456, "client_secret_expires_at": 0, "client_name": "Updated Application Name", "redirect_uris": [ "https://client.example.org/callback", "https://client.example.org/callback2" ], "grant_types": [ "authorization_code", "refresh_token" ], "response_types": [ "code" ], "token_endpoint_auth_method": "client_secret_basic", "client_uri": "https://client.example.org", "description": "Updated OAuth 2.0 application description", "token_expires_in": 7200 } } } }, "400": { "description": "Invalid request" }, "401": { "description": "Unauthorized - invalid registration access token" }, "404": { "description": "Client not found" } }, "security": [ { "BearerAuth": [] } ] } }, "/oauth2/revoke": { "post": { "tags": [ "OAuth 2.0" ], "summary": "Revoke OAuth 2.0 token", "operationId": "revoke", "parameters": [ { "name": "Authorization", "in": "header", "description": "Basic authentication credentials: Basic base64(client_id:client_secret)", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "Token to revoke" }, "access_token": { "type": "string", "description": "Token to revoke" }, "token_type_hint": { "type": "string", "description": "Hint about the type of token being revoked (access_token or refresh_token)" }, "client_id": { "type": "string", "description": "OAuth 2.0 client identifier", "example": "123-api-buddy-client" } } } } } }, "responses": { "200": { "description": "Token successfully revoked" }, "400": { "description": "Invalid request - missing or invalid parameters" }, "401": { "description": "Unauthorized - invalid client credentials" } } } }, "/oauth2/token": { "post": { "tags": [ "OAuth 2.0" ], "summary": "Issue OAuth 2.0 token", "operationId": "token", "parameters": [ { "name": "Authorization", "in": "header", "description": "Basic authentication credentials: Basic base64(client_id:client_secret)", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "required": [ "grant_type" ], "type": "object", "properties": { "grant_type": { "type": "string", "description": "Grant type: authorization_code, client_credentials, or refresh_token", "example": "authorization_code" }, "client_id": { "type": "string", "description": "OAuth 2.0 client identifier", "example": "123-api-buddy-client" }, "client_secret": { "type": "string", "description": "OAuth 2.0 client secret" }, "code": { "type": "string", "description": "Authorization code (required for authorization_code grant)", "example": "SplxlOBeZQQYbYS6WxSbIA" }, "redirect_uri": { "type": "string", "description": "Redirect URI" }, "code_verifier": { "type": "string", "description": "PKCE code verifier" }, "refresh_token": { "type": "string", "description": "Refresh token (required for refresh_token grant)" }, "scope": { "type": "string", "description": "Requested OAuth 2.0 scopes (required for client_credentials grant)", "example": "WORKSPACE" } } } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenFront" }, "example": { "access_token": "e4d6521d0cbad72e1e7f2d0ba3ef74b6b2e7a5c8", "token_type": "Bearer", "expires_in": 3600, "refresh_token": "7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c", "refresh_token_expires_in": 15811201 } } } }, "400": { "description": "Invalid request - missing or invalid parameters" }, "401": { "description": "Unauthorized - invalid client credentials" } } } }, "/unit-tests/import": { "post": { "tags": [ "Unit Test API" ], "summary": "Import test session from JUnit XML file(s) using suite token authentication", "description": "Import a test session by uploading one or more JUnit XML files. This endpoint accepts multipart/form-data with test report files and optional metadata fields.\n\n**Authentication:** Include the suite token in the header: `Authorization: Bearer `\n\nThe endpoint automatically parses JUnit XML format, extracts test groups (test suites) and test cases, and creates a complete test session with all results.\n\n**Example using curl:**\n```bash\ncurl -X POST https://api.buddy.works/unit-tests/import \\\n -H \"Authorization: Bearer bud_ut_us_...\" \\\n -F \"files=@test-results-1.xml\" \\\n -F \"files=@test-results-2.xml\" \\\n -F \"ci_provider=GITHUB_ACTION\" \\\n -F \"ci_run_url=https://github.com/user/repo/actions/runs/123456\" \\\n -F \"revision=b2c3d4e5...\" \\\n -F \"ref_type=BRANCH\" \\\n -F \"ref_name=main\"\n```\n", "operationId": "importSession", "parameters": [], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ImportSessionRequest" } } }, "required": true }, "responses": { "201": { "description": "Test session created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestSessionView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites/MNbyVedg/sessions/r4nBYXVq", "html_url": "https://app.buddy.works/my-workspace/my-project/unit-tests/MNbyVedg/r4nBYXVq", "id": "r4nBYXVq", "relative_id": 1, "create_date": "2025-10-21T06:42:08Z", "start_date": "2025-10-21T06:42:08Z", "created_by": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1760014081477", "email": "john.doe@company.com", "admin": true, "workspace_owner": true }, "ci_provider": "BUDDY", "revision": "755b691cfff32e08aba35f2c9b1451ed76cfd583", "ref_type": "BRANCH", "ref_name": "master", "execution_id": "68f72b3d66907cbc77887986", "action_execution_id": "68f72b3d66907cbc77887988", "status": "SUCCESSFUL", "duration": 1, "tests_count": 109, "failed_count": 0, "skipped_count": 0, "error_count": 0 } } } } } } }, "/unit-tests/sessions": { "post": { "tags": [ "Unit Test API" ], "summary": "Add a new test session using suite token authentication", "description": "Authentication: Include the suite token in the header: `Authorization: Bearer `", "operationId": "addSessionByToken", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddSessionRequest" }, "examples": { "Add test session": { "description": "Add test session", "value": { "ci_provider": "GITHUB_ACTION", "revision": "b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1", "ref_type": "BRANCH", "ref_name": "main", "run_id": "12345678", "created_by": { "id": 123 } } } } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestSessionView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites/MNbyVedg/sessions/r4nBYXVq", "html_url": "https://app.buddy.works/my-workspace/my-project/unit-tests/MNbyVedg/r4nBYXVq", "id": "r4nBYXVq", "relative_id": 1, "create_date": "2025-10-21T06:42:08Z", "start_date": "2025-10-21T06:42:08Z", "created_by": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1760014081477", "email": "john.doe@company.com", "admin": true, "workspace_owner": true }, "ci_provider": "BUDDY", "revision": "755b691cfff32e08aba35f2c9b1451ed76cfd583", "ref_type": "BRANCH", "ref_name": "master", "execution_id": "68f72b3d66907cbc77887986", "action_execution_id": "68f72b3d66907cbc77887988", "status": "SUCCESSFUL", "duration": 1, "tests_count": 109, "failed_count": 0, "skipped_count": 0, "error_count": 0 } } } } } } }, "/unit-tests/sessions/{session_id}/cases": { "put": { "tags": [ "Unit Test API" ], "summary": "Add or update a test case using suite token authentication", "description": "Authentication: Include the suite token in the header: `Authorization: Bearer `", "operationId": "upsertCaseByToken", "parameters": [ { "name": "session_id", "in": "path", "description": "The ID of the test session", "required": true, "schema": { "type": "string", "example": "r4nBYXVq" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddTestCaseRequest" }, "example": { "name": "testUserLogin", "test_group_name": "com.example.tests.IntegrationTests", "classname": "com.example.tests.IntegrationTests", "status": "PASSED", "time": 2.5, "data": "" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestCaseView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites/5ddb7c180fb38be67bd78a88a/sessions/5ddb7c180fb38be67bd78a88b/test-groups/com.example.tests.IntegrationTests/cases/com.example.tests.IntegrationTests.testUserLogin", "html_url": "https://app.buddy.works/my-workspace/projects/my-project/unit-tests/suites/5ddb7c180fb38be67bd78a88a/sessions/5ddb7c180fb38be67bd78a88b/test-groups/com.example.tests.IntegrationTests/cases/com.example.tests.IntegrationTests.testUserLogin", "id": "com.example.tests.IntegrationTests.testUserLogin", "name": "testUserLogin", "test_group_name": "com.example.tests.IntegrationTests", "test_group_id": "com.example.tests.IntegrationTests", "classname": "com.example.tests.IntegrationTests", "status": "PASSED", "time": 2.5, "data": "" } } } } } } }, "/unit-tests/sessions/{sessionId}/cases/batch": { "post": { "tags": [ "Unit Test API" ], "summary": "Add multiple test cases in batch using suite token authentication", "description": "Authentication: Include the suite token in the header: `Authorization: Bearer `", "operationId": "addCasesByToken", "parameters": [ { "name": "sessionId", "in": "path", "description": "The ID of the test session", "required": true, "schema": { "type": "string", "example": "r4nBYXVq" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddCasesRequest" }, "example": { "cases": [ { "name": "testUserLogin", "test_group_name": "com.example.tests.IntegrationTests", "classname": "com.example.tests.IntegrationTests", "status": "PASSED", "time": 2.5, "data": "" }, { "name": "testUserLogout", "test_group_name": "com.example.tests.IntegrationTests", "classname": "com.example.tests.IntegrationTests", "status": "PASSED", "time": 1.2, "data": "" }, { "name": "testPasswordReset", "test_group_name": "com.example.tests.IntegrationTests", "classname": "com.example.tests.IntegrationTests", "status": "SKIPPED", "time": 0, "data": "" } ] } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestCasesView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites/5ddb7c180fb38be67bd78a88a/sessions/5ddb7c180fb38be67bd78a88b/cases", "html_url": "https://app.buddy.works/my-workspace/projects/my-project/unit-tests/suites/5ddb7c180fb38be67bd78a88a/sessions/5ddb7c180fb38be67bd78a88b", "cases": [ { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites/5ddb7c180fb38be67bd78a88a/sessions/5ddb7c180fb38be67bd78a88b/test-groups/com.example.UserServiceTest/cases/com.example.UserServiceTest.testShouldReturnSuccess", "html_url": "https://app.buddy.works/my-workspace/projects/my-project/unit-tests/suites/5ddb7c180fb38be67bd78a88a/sessions/5ddb7c180fb38be67bd78a88b", "id": "com.example.UserServiceTest.testShouldReturnSuccess", "name": "testShouldReturnSuccess", "test_group_name": "com.example.UserServiceTest", "test_group_id": "com.example.UserServiceTest", "classname": "com.example.UserServiceTest", "status": "PASSED", "time": 0.123 }, { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites/5ddb7c180fb38be67bd78a88a/sessions/5ddb7c180fb38be67bd78a88b/test-groups/com.example.UserServiceTest/cases/com.example.UserServiceTest.testShouldHandleError", "html_url": "https://app.buddy.works/my-workspace/projects/my-project/unit-tests/suites/5ddb7c180fb38be67bd78a88a/sessions/5ddb7c180fb38be67bd78a88b", "id": "com.example.UserServiceTest.testShouldHandleError", "name": "testShouldHandleError", "test_group_name": "com.example.UserServiceTest", "test_group_id": "com.example.UserServiceTest", "classname": "com.example.UserServiceTest", "status": "FAILED", "time": 0.456 }, { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites/5ddb7c180fb38be67bd78a88a/sessions/5ddb7c180fb38be67bd78a88b/test-groups/com.example.PaymentServiceTest/cases/com.example.PaymentServiceTest.testSkipped", "html_url": "https://app.buddy.works/my-workspace/projects/my-project/unit-tests/suites/5ddb7c180fb38be67bd78a88a/sessions/5ddb7c180fb38be67bd78a88b", "id": "com.example.PaymentServiceTest.testSkipped", "name": "testSkipped", "test_group_name": "com.example.PaymentServiceTest", "test_group_id": "com.example.PaymentServiceTest", "classname": "com.example.PaymentServiceTest", "status": "SKIPPED", "time": 0 } ] } } } } } } }, "/unit-tests/sessions/{session_id}/close": { "post": { "tags": [ "Unit Test API" ], "summary": "Close a test session using suite token authentication", "description": "Authentication: Include the suite token in the header: `Authorization: Bearer `", "operationId": "closeSessionByToken", "parameters": [ { "name": "session_id", "in": "path", "description": "The ID of the test session", "required": true, "schema": { "type": "string", "example": "r4nBYXVq" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestSessionView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites/MNbyVedg/sessions/r4nBYXVq", "html_url": "https://app.buddy.works/my-workspace/my-project/unit-tests/MNbyVedg/r4nBYXVq", "id": "r4nBYXVq", "relative_id": 1, "create_date": "2025-10-21T06:42:08Z", "start_date": "2025-10-21T06:42:08Z", "created_by": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1760014081477", "email": "john.doe@company.com", "admin": true, "workspace_owner": true }, "ci_provider": "BUDDY", "revision": "755b691cfff32e08aba35f2c9b1451ed76cfd583", "ref_type": "BRANCH", "ref_name": "master", "execution_id": "68f72b3d66907cbc77887986", "action_execution_id": "68f72b3d66907cbc77887988", "status": "SUCCESSFUL", "duration": 1, "tests_count": 109, "failed_count": 0, "skipped_count": 0, "error_count": 0 } } } } } } }, "/unit-tests/sessions/{session_id}/reopen": { "post": { "tags": [ "Unit Test API" ], "summary": "Reopen a closed test session using suite token authentication", "description": "Authentication: Include the suite token in the header: `Authorization: Bearer `", "operationId": "reopenSessionByToken", "parameters": [ { "name": "session_id", "in": "path", "description": "The ID of the test session", "required": true, "schema": { "type": "string", "example": "r4nBYXVq" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestSessionView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites/MNbyVedg/sessions/r4nBYXVq", "html_url": "https://app.buddy.works/my-workspace/my-project/unit-tests/MNbyVedg/r4nBYXVq", "id": "r4nBYXVq", "relative_id": 1, "create_date": "2025-10-21T06:42:08Z", "start_date": "2025-10-21T06:42:08Z", "created_by": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1760014081477", "email": "john.doe@company.com", "admin": true, "workspace_owner": true }, "ci_provider": "BUDDY", "revision": "755b691cfff32e08aba35f2c9b1451ed76cfd583", "ref_type": "BRANCH", "ref_name": "master", "execution_id": "68f72b3d66907cbc77887986", "action_execution_id": "68f72b3d66907cbc77887988", "status": "SUCCESSFUL", "duration": 1, "tests_count": 109, "failed_count": 0, "skipped_count": 0, "error_count": 0 } } } } } } }, "/user": { "get": { "tags": [ "User API" ], "summary": "Returns the details of the authorized user", "operationId": "getUser", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserView" }, "example": { "url": "https://api.buddy.works/user", "html_url": "https://app.buddy.works/my-id", "id": 123, "name": "john.doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/123/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6/w/32/32/AVATAR.png?ts=1724320218123", "workspaces_url": "https://api.buddy.works/workspaces", "email": "john.doe@company.com" } } } } }, "security": [ { "oauth2": [ "USER_INFO" ] } ] }, "patch": { "tags": [ "User API" ], "summary": "Updates the authorized user", "operationId": "updateUser", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserRequest" }, "example": { "name": "John Doe" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserView" }, "example": { "url": "https://api.buddy.works/user", "html_url": "https://app.buddy.works/my-id", "id": 123, "name": "john.doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/123/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6/w/32/32/AVATAR.png?ts=1724320218123", "workspaces_url": "https://api.buddy.works/workspaces", "email": "john.doe@company.com" } } } } }, "security": [ { "oauth2": [ "USER_INFO" ] } ] } }, "/user/emails": { "get": { "tags": [ "User API" ], "summary": "Get user's email addresses", "operationId": "getEmails", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserEmailsView" }, "example": { "url": "https://api.buddy.works/user/emails", "html_url": "https://app.buddy.works/my-id", "emails": [ { "email": "john.doe@company.com", "confirmed": true }, { "email": "john.doe.alt@company.com", "confirmed": false } ] } } } } }, "security": [ { "oauth2": [ "USER_EMAIL" ] } ] }, "post": { "tags": [ "User API" ], "summary": "Add email address to user account", "operationId": "addEmail", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddEmailRequest" }, "example": { "email": "john.doe.alt@company.com" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserEmailView" }, "example": { "url": "https://api.buddy.works/user/emails", "html_url": "https://app.buddy.works/my-id", "email": "john.doe.alt@company.com", "confirmed": false } } } } }, "security": [ { "oauth2": [ "MANAGE_EMAILS" ] } ] } }, "/user/emails/{email}": { "delete": { "tags": [ "User API" ], "summary": "Delete an email address", "operationId": "deleteEmail", "parameters": [ { "name": "email", "in": "path", "description": "The email address", "required": true, "schema": { "type": "string", "example": "user@example.com" } } ], "responses": { "204": { "description": "Email address deleted successfully" } }, "security": [ { "oauth2": [ "MANAGE_EMAILS" ] } ] } }, "/user/keys": { "get": { "tags": [ "User API" ], "summary": "Get user's SSH keys", "operationId": "getKeys", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicSSHKeysView" }, "example": { "url": "https://api.buddy.works/user/keys", "html_url": "https://app.buddy.works/security", "keys": [ { "url": "https://api.buddy.works/user/keys/456", "html_url": "https://app.buddy.works/ssh-keys/details/456", "id": 456, "title": "My Development Key", "content": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC7VLpP... user@example.com" }, { "url": "https://api.buddy.works/user/keys/789", "html_url": "https://app.buddy.works/ssh-keys/details/789", "id": 789, "title": "Server Key", "content": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQD2XfgH... server@company.com" } ] } } } } }, "security": [ { "oauth2": [ "USER_KEY" ] } ] }, "post": { "tags": [ "User API" ], "summary": "Registers a new public SSH key for the authorized user", "operationId": "addKey", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddSSHKeyRequest" }, "example": { "title": "My Development Key", "content": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC7VLpP... user@example.com" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicSSHKeyView" }, "example": { "url": "https://api.buddy.works/user/keys/456", "html_url": "https://app.buddy.works/ssh-keys/details/456", "id": 456, "title": "My Development Key", "content": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC7VLpP... user@example.com" } } } } }, "security": [ { "oauth2": [ "USER_KEY" ] } ] } }, "/user/keys/{id}": { "get": { "tags": [ "User API" ], "summary": "Returns the public SSH key of the authorized user", "operationId": "getKey", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the SSH key", "required": true, "schema": { "type": "integer", "format": "int32", "example": 456 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicSSHKeyView" }, "example": { "url": "https://api.buddy.works/user/keys/456", "html_url": "https://app.buddy.works/ssh-keys/details/456", "id": 456, "title": "My Development Key", "content": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC7VLpP... user@example.com" } } } } }, "security": [ { "oauth2": [ "USER_KEY" ] } ] }, "delete": { "tags": [ "User API" ], "summary": "Deletes a public SSH key of the authorized user", "operationId": "deleteKey", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the SSH key", "required": true, "schema": { "type": "integer", "format": "int32", "example": 456 } } ], "responses": { "204": { "description": "SSH key deleted successfully" } }, "security": [ { "oauth2": [ "USER_KEY" ] } ] } }, "/user/oidc/tokens": { "post": { "tags": [ "OIDC API" ], "summary": "Issue a short-lived API token using OIDC provider authentication", "operationId": "issueCredentialsWithOIDCProvider", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueTokenRequest" }, "example": { "provider_id": "550e8400-e29b-41d4-a716-446655440000", "web_identity_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL2FjY291bnRzLmdvb2dsZS5jb20iLCJhdWQiOiIxMjM0NTY3ODkwLWFiY2RlZmdoaWprbG1ub3BxcnN0dXZ3eHl6LmFwcHMuZ29vZ2xldXNlcmNvbnRlbnQuY29tIiwic3ViIjoiMTIzNDU2Nzg5MDEyMzQ1Njc4OTAiLCJlbWFpbCI6InVzZXJAZXhhbXBsZS5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwiaWF0IjoxNjg5MDAwMDAwLCJleHAiOjE2ODkwMDM2MDB9.example_signature" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "string", "description": "Short-lived API access token" }, "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" } } } } } }, "/user/token": { "get": { "tags": [ "User API" ], "summary": "Get personal access token used for authorization", "operationId": "getToken_1", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessTokenView" }, "example": { "url": "https://api.buddy.works/user/tokens/ed0f8927-c116-4afe-b555-c888dfd86c92", "html_url": "https://app.buddy.works/api-tokens/details/ed0f8927-c116-4afe-b555-c888dfd86c92", "id": "ed0f8927-c116-4afe-b555-c888dfd86c92", "name": "My API Token", "expires_at": "2025-10-17T10:30:18.123456789Z", "scopes": [ "WORKSPACE", "REPOSITORY_READ" ], "ip_restrictions": [ "192.168.1.100", "10.0.0.0/8" ], "workspace_restrictions": [ "my-workspace" ] } } } } }, "security": [ { "oauth2": [ "TOKEN_INFO" ] } ] } }, "/user/tokens": { "get": { "tags": [ "User API" ], "summary": "Get list of personal access tokens", "operationId": "getTokens", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessTokensView" }, "example": { "url": "https://api.buddy.works/user/tokens", "html_url": "https://app.buddy.works/security", "access_tokens": [ { "url": "https://api.buddy.works/user/tokens/ed0f8927-c116-4afe-b555-c888dfd86c92", "html_url": "https://app.buddy.works/api-tokens/details/ed0f8927-c116-4afe-b555-c888dfd86c92", "id": "ed0f8927-c116-4afe-b555-c888dfd86c92", "name": "My API Token", "expires_at": "2025-10-17T10:30:18.123456789Z" }, { "url": "https://api.buddy.works/user/tokens/a1b2c3d4-e5f6-789a-bcde-f012345678ab", "html_url": "https://app.buddy.works/api-tokens/details/a1b2c3d4-e5f6-789a-bcde-f012345678ab", "id": "a1b2c3d4-e5f6-789a-bcde-f012345678ab", "name": "CI/CD Token", "expires_at": "2025-09-30T15:45:33.987654321Z" } ] } } } } }, "security": [ { "oauth2": [ "TOKEN_INFO" ] } ] }, "post": { "tags": [ "User API" ], "summary": "Add personal access token", "operationId": "addToken", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddAccessTokenRequest" }, "example": { "name": "My API Token", "expires_in": 30, "scopes": [ "WORKSPACE", "REPOSITORY_READ" ], "ip_restrictions": [ "192.168.1.100", "10.0.0.0/8" ], "workspace_restrictions": [ "my-workspace" ] } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessTokenView" }, "example": { "url": "https://api.buddy.works/user/tokens/ed0f8927-c116-4afe-b555-c888dfd86c92", "html_url": "https://app.buddy.works/api-tokens/details/ed0f8927-c116-4afe-b555-c888dfd86c92", "id": "ed0f8927-c116-4afe-b555-c888dfd86c92", "name": "My API Token", "token": "ed0f8927-c116-4afe-b555-c888dfd86c92", "expires_at": "2025-10-17T10:30:18.123456789Z", "scopes": [ "WORKSPACE", "REPOSITORY_READ" ], "ip_restrictions": [ "192.168.1.100", "10.0.0.0/8" ], "workspace_restrictions": [ "my-workspace" ] } } } } }, "security": [ { "oauth2": [ "TOKEN_MANAGE" ] } ] } }, "/user/tokens/{id}": { "get": { "tags": [ "User API" ], "summary": "Get personal access token by ID", "operationId": "getToken_2", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the access token", "required": true, "schema": { "type": "string", "example": "ed0f8927-c116-4afe-b555-c888dfd86c92" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessTokenView" }, "example": { "url": "https://api.buddy.works/user/tokens/ed0f8927-c116-4afe-b555-c888dfd86c92", "html_url": "https://app.buddy.works/api-tokens/details/ed0f8927-c116-4afe-b555-c888dfd86c92", "id": "ed0f8927-c116-4afe-b555-c888dfd86c92", "name": "My API Token", "expires_at": "2025-10-17T10:30:18.123456789Z", "scopes": [ "WORKSPACE", "REPOSITORY_READ" ], "ip_restrictions": [ "192.168.1.100", "10.0.0.0/8" ], "workspace_restrictions": [ "my-workspace" ] } } } } } }, "delete": { "tags": [ "User API" ], "summary": "Delete personal access token", "operationId": "deleteToken", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the access token", "required": true, "schema": { "type": "string", "example": "ed0f8927-c116-4afe-b555-c888dfd86c92" } } ], "responses": { "204": { "description": "Access token deleted successfully" } } } }, "/workspaces": { "get": { "tags": [ "Workspace API" ], "summary": "Get all workspaces accessible to the user", "operationId": "getWorkspaces", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspacesView" }, "example": { "url": "https://api.buddy.works/workspaces", "html_url": "https://app.buddy.works/workspaces", "workspaces": [ { "url": "https://api.buddy.works/workspaces/my-company", "html_url": "https://app.buddy.works/my-company", "id": 1, "name": "My Company", "domain": "my-company" }, { "url": "https://api.buddy.works/workspaces/other-company", "html_url": "https://app.buddy.works/other-company", "id": 2, "name": "Other Company", "domain": "other-company" } ] } } } } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] } }, "/workspaces/{workspace_domain}": { "get": { "tags": [ "Workspace API" ], "summary": "Get a specific workspace by domain", "operationId": "getWorkspace", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceView" }, "example": { "url": "https://api.buddy.works/workspaces/my-company", "html_url": "https://app.buddy.works/my-company", "id": 1, "name": "My Company", "domain": "my-company", "owner_id": 123, "frozen": false, "create_date": "2023-01-15T10:30:00.123456789Z", "default_pipeline_resource": "MEDIUM", "sso_enabled": true, "public_pipelines_disabled": false } } } } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] } }, "/workspaces/{workspace_domain}/artifacts": { "get": { "tags": [ "Artifact API" ], "summary": "Get artifacts list", "operationId": "getArtifacts", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "query", "description": "The human-readable ID of the project", "schema": { "type": "string", "example": "my-project" } }, { "name": "environment_id", "in": "query", "description": "The ID of the environment", "schema": { "type": "string", "example": "nZrnl40Y" } } ], "responses": { "200": { "description": "List of artifacts retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactsView" }, "examples": { "all-artifacts": { "summary": "All artifacts in workspace", "description": "all-artifacts", "value": { "url": "https://api.buddy.works/workspaces/ttests/artifacts", "html_url": "https://app.buddy.works/ttests/-/artifacts", "artifacts": [ { "url": "https://api.buddy.works/workspaces/ttests/artifacts/lV1bAjo2", "html_url": "https://app.buddy.works/ttests/-/artifacts/lV1bAjo2/versions", "id": "lV1bAjo2", "type": "CONTAINER", "name": "My Application Artifact", "identifier": "my-app-artifact", "scope": "WORKSPACE", "size": 1048576000 }, { "url": "https://api.buddy.works/workspaces/ttests/artifacts/N6j4zgB4", "html_url": "https://app.buddy.works/ttests/-/artifacts/N6j4zgB4/versions", "id": "N6j4zgB4", "type": "CONTAINER", "name": "Shared Library Artifact", "identifier": "shared-lib", "scope": "WORKSPACE", "size": 2147483648 } ] } }, "filtered-by-project": { "summary": "All artifacts in project", "description": "filtered-by-project", "value": { "url": "https://api.buddy.works/workspaces/ttests/artifacts", "html_url": "https://app.buddy.works/ttests/-/artifacts", "artifacts": [ { "url": "https://api.buddy.works/workspaces/ttests/artifacts/lV1bAjo2", "html_url": "https://app.buddy.works/ttests/-/artifacts/lV1bAjo2/versions", "id": "lV1bAjo2", "type": "CONTAINER", "name": "My Application Artifact", "identifier": "my-app-artifact", "scope": "PROJECT", "size": 1048576000 } ] } }, "filtered-by-environment": { "summary": "All artifacts in environment", "description": "filtered-by-environment", "value": { "url": "https://api.buddy.works/workspaces/ttests/artifacts", "html_url": "https://app.buddy.works/ttests/-/artifacts", "artifacts": [ { "url": "https://api.buddy.works/workspaces/ttests/artifacts/lV1bAjo2", "html_url": "https://app.buddy.works/ttests/-/artifacts/lV1bAjo2/versions", "id": "lV1bAjo2", "type": "BUCKET", "name": "Environment Artifact", "identifier": "env-artifact", "scope": "ENVIRONMENT", "size": 786432000 } ] } } } } } } }, "security": [ { "oauth2": [ "ARTIFACT_READ" ] } ] }, "post": { "tags": [ "Artifact API" ], "summary": "Create a new artifact", "operationId": "createArtifact", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateArtifactRequest" }, "examples": { "workspace-artifact": { "summary": "Workspace-scoped artifact", "description": "workspace-artifact", "value": { "name": "My Workspace Artifact", "type": "CONTAINER", "scope": "WORKSPACE" } }, "project-artifact": { "summary": "Project-scoped artifact", "description": "project-artifact", "value": { "name": "My Project Artifact", "type": "CONTAINER", "scope": "PROJECT", "project": { "name": "my-project" } } }, "environment-artifact": { "summary": "Environment-scoped artifact", "description": "environment-artifact", "value": { "name": "My Environment Artifact", "type": "BUCKET", "scope": "ENVIRONMENT", "environment": { "id": "nZrnl40Y" } } }, "secure-artifact": { "summary": "Artifact with authentication", "description": "secure-artifact", "value": { "name": "Secure Artifact", "type": "BUCKET", "scope": "PROJECT", "project": { "name": "secure-project" }, "authorization": { "type": "BASIC", "user": "apiuser", "password": "securepass123" } } } } } } }, "responses": { "201": { "description": "Artifact created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactView" }, "example": { "url": "https://api.buddy.works/workspaces/ttests/artifacts/x5169jL2", "html_url": "https://app.buddy.works/ttests/-/artifacts/x5169jL2/versions", "id": "x5169jL2", "name": "My New Artifact", "identifier": "my-new-artifact", "type": "CONTAINER", "project": { "url": "https://api.buddy.works/workspaces/ttests/projects/my-project", "html_url": "https://app.buddy.works/ttests/projects/my-project", "name": "my-project", "display_name": "My Project" }, "scope": "PROJECT", "authorization": { "type": "BUDDY" }, "permissions": { "others": "READ_ONLY", "users": [ { "id": 42, "access_level": "MANAGE" } ] }, "size": 1073741824, "created_date": "2024-01-22T09:15:00Z" } } } } }, "security": [ { "oauth2": [ "ARTIFACT_WRITE" ] } ] } }, "/workspaces/{workspace_domain}/artifacts/{artifactId}": { "get": { "tags": [ "Artifact API" ], "summary": "Get a specific artifact by ID", "operationId": "getArtifact", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "artifactId", "in": "path", "description": "The Artifact ID", "required": true, "schema": { "type": "string", "example": "x5169jL2" } } ], "responses": { "200": { "description": "Artifact retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactView" }, "examples": { "Get artifact": { "summary": "Workspace-scoped artifact", "description": "Get artifact", "value": { "url": "https://api.buddy.works/workspaces/ttests/artifacts/x5169jL2", "html_url": "https://app.buddy.works/ttests/-/artifacts/x5169jL2/versions", "id": "x5169jL2", "name": "Shared Library Artifact", "identifier": "shared-lib", "type": "CONTAINER", "scope": "WORKSPACE", "authorization": { "type": "NONE" }, "permissions": { "others": "READ_ONLY" }, "size": 2147483648, "created_date": "2024-01-10T08:20:00Z" } } } } } } }, "security": [ { "oauth2": [ "ARTIFACT_READ" ] } ] }, "delete": { "tags": [ "Artifact API" ], "summary": "Delete a artifact", "operationId": "deleteArtifact", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "artifactId", "in": "path", "description": "The Artifact ID", "required": true, "schema": { "type": "string", "example": "x5169jL2" } } ], "responses": { "204": { "description": "Artifact deleted successfully" } }, "security": [ { "oauth2": [ "ARTIFACT_MANAGE" ] } ] }, "patch": { "tags": [ "Artifact API" ], "summary": "Update artifact configuration", "operationId": "updateArtifact", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "artifactId", "in": "path", "description": "The Artifact ID", "required": true, "schema": { "type": "string", "example": "x5169jL2" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateArtifactRequest" }, "examples": { "update-name": { "summary": "Update artifact name", "description": "update-name", "value": { "name": "updated-artifact-name" } }, "update-scope": { "summary": "Update artifact scope", "description": "update-scope", "value": { "scope": "WORKSPACE" } }, "update-auth": { "summary": "Update artifact authorization", "description": "update-auth", "value": { "authorization": { "type": "NONE" } } } } } } }, "responses": { "200": { "description": "Artifact updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactView" }, "example": { "url": "https://api.buddy.works/workspaces/ttests/artifacts/x5169jL2", "html_url": "https://app.buddy.works/ttests/-/artifacts/x5169jL2/versions", "id": "x5169jL2", "name": "Updated Artifact Name", "identifier": "my-app-artifact", "type": "BUCKET", "project": { "url": "https://api.buddy.works/workspaces/ttests/projects/my-project", "html_url": "https://app.buddy.works/ttests/projects/my-project", "name": "my-project", "display_name": "My Project" }, "environment": { "url": "https://api.buddy.works/workspaces/ttests/projects/my-project/environments/nZrnl40Y", "html_url": "https://app.buddy.works/ttests/projects/my-project/environments/nZrnl40Y", "name": "staging", "identifier": "my-staging", "id": "nZrnl40Y", "scope": "PROJECT" }, "scope": "WORKSPACE", "authorization": { "type": "NONE" }, "permissions": { "others": "READ_ONLY", "users": [ { "id": 42, "access_level": "READ_WRITE" } ], "groups": [ { "id": 15, "access_level": "READ_ONLY" } ] }, "size": 524288000, "created_date": "2024-01-15T10:30:00Z" } } } } }, "security": [ { "oauth2": [ "ARTIFACT_WRITE" ] } ] } }, "/workspaces/{workspace_domain}/artifacts/{artifactId}/versions": { "get": { "tags": [ "Artifact Versions API" ], "summary": "Get artifact versions list", "operationId": "getArtifactVersions", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "artifactId", "in": "path", "description": "The Artifact ID", "required": true, "schema": { "type": "string", "example": "x5169jL2" } }, { "name": "page", "in": "query", "description": "Page number for pagination", "schema": { "type": "integer", "format": "int64", "example": 1 } }, { "name": "per_page", "in": "query", "description": "Number of items per page", "schema": { "type": "integer", "format": "int64", "example": 20 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactVersionsView" }, "example": { "url": "https://api.buddy.works/workspaces/ttests/artifacts/x5169jL2/versions", "html_url": "https://app.buddy.works/ttests/-/artifacts/x5169jL2/versions", "versions": [ { "url": "https://api.buddy.works/workspaces/ttests/artifacts/x5169jL2/versions/0YgEzRGv", "html_url": "https://app.buddy.works/ttests/-/artifacts/x5169jL2/versions/0YgEzRGv", "version_url": "https://latest-my-artifact.bucket-1.registry.sh/", "id": "0YgEzRGv", "version": "latest", "size": 1048576, "created_date": "2024-01-20T10:30:00Z" }, { "url": "https://api.buddy.works/workspaces/ttests/artifacts/x5169jL2/versions/WpgpeR2J", "html_url": "https://app.buddy.works/ttests/-/artifacts/x5169jL2/versions/WpgpeR2J", "version_url": "https://v1-1-0-my-artifact.bucket-1.registry.sh/", "id": "WpgpeR2J", "version": "v1.1.0", "size": 987654, "created_date": "2024-01-15T08:20:00Z" } ] } } } } }, "security": [ { "oauth2": [ "ARTIFACT_READ" ] } ] }, "post": { "tags": [ "Artifact Versions API" ], "summary": "Create a new artifact version", "operationId": "createArtifactVersion", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "artifactId", "in": "path", "description": "The Artifact ID", "required": true, "schema": { "type": "string", "example": "x5169jL2" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateArtifactVersionRequest" }, "example": { "version": "v1.2.1" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactVersionView" }, "example": { "url": "https://api.buddy.works/workspaces/ttests/artifacts/x5169jL2/versions/0YgEzRGv", "html_url": "https://app.buddy.works/ttests/-/artifacts/x5169jL2/versions/0YgEzRGv", "version_url": "https://v1-2-1-my-artifact.bucket-1.registry.sh/", "id": "0YgEzRGv", "version": "v1.2.1", "size": 0, "created_date": "2024-01-22T12:00:00Z" } } } } }, "security": [ { "oauth2": [ "ARTIFACT_WRITE" ] } ] } }, "/workspaces/{workspace_domain}/artifacts/{artifactId}/versions/{versionId}": { "get": { "tags": [ "Artifact Versions API" ], "summary": "Get a specific artifact version", "operationId": "getArtifactVersion", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "artifactId", "in": "path", "description": "The Artifact ID", "required": true, "schema": { "type": "string", "example": "x5169jL2" } }, { "name": "versionId", "in": "path", "description": "The Version ID", "required": true, "schema": { "type": "string", "example": "a9f84k2L" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactVersionView" }, "example": { "url": "https://api.buddy.works/workspaces/ttests/artifacts/x5169jL2/versions/0YgEzRGv", "html_url": "https://app.buddy.works/ttests/-/artifacts/x5169jL2/versions/0YgEzRGv", "version_url": "https://latest-my-artifact.bucket-1.registry.sh/", "id": "0YgEzRGv", "version": "latest", "size": 1048576, "created_date": "2024-01-20T10:30:00Z" } } } } }, "security": [ { "oauth2": [ "ARTIFACT_READ" ] } ] }, "delete": { "tags": [ "Artifact Versions API" ], "summary": "Delete a artifact version", "operationId": "deleteArtifactVersion", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "artifactId", "in": "path", "description": "The Artifact ID", "required": true, "schema": { "type": "string", "example": "x5169jL2" } }, { "name": "versionId", "in": "path", "description": "The Version ID", "required": true, "schema": { "type": "string", "example": "a9f84k2L" } } ], "responses": { "204": { "description": "Artifact version deleted successfully" } }, "security": [ { "oauth2": [ "ARTIFACT_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/artifacts/{artifactId}/versions/{versionId}/content": { "get": { "tags": [ "Artifact Versions API" ], "summary": "Get artifact version root content", "operationId": "getArtifactVersionRootContent", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "artifactId", "in": "path", "description": "The Artifact ID", "required": true, "schema": { "type": "string", "example": "x5169jL2" } }, { "name": "versionId", "in": "path", "description": "The Version ID", "required": true, "schema": { "type": "string", "example": "a9f84k2L" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactVersionContentView" }, "example": { "url": "https://api.buddy.works/workspaces/ttests/artifacts/x5169jL2/versions/a9f84k2L/content", "html_url": "https://app.buddy.works/ttests/-/artifacts/x5169jL2/versions/a9f84k2L/content", "contents": [ { "url": "https://api.buddy.works/workspaces/ttests/artifacts/x5169jL2/versions/a9f84k2L/content?path=README.md", "html_url": "https://app.buddy.works/ttests/-/artifacts/x5169jL2/versions/a9f84k2L/content/README.md", "type": "FILE", "name": "README.md", "path": "/dir/README.md", "size": 2048 }, { "url": "https://api.buddy.works/workspaces/ttests/artifacts/x5169jL2/versions/a9f84k2L/content?path=src", "html_url": "https://app.buddy.works/ttests/-/artifacts/x5169jL2/versions/a9f84k2L/content/src", "type": "DIR", "name": "src", "path": "/dir/src" } ] } } } } }, "security": [ { "oauth2": [ "ARTIFACT_READ" ] } ] } }, "/workspaces/{workspace_domain}/artifacts/{artifactId}/versions/{versionId}/content/{path}": { "get": { "tags": [ "Artifact Versions API" ], "summary": "Get artifact version content at specific path", "operationId": "getArtifactVersionContentByPath", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "artifactId", "in": "path", "description": "The Artifact ID", "required": true, "schema": { "type": "string", "example": "x5169jL2" } }, { "name": "versionId", "in": "path", "description": "The Version ID", "required": true, "schema": { "type": "string", "example": "a9f84k2L" } }, { "name": "path", "in": "path", "description": "The file or directory location in the artifact version", "required": true, "schema": { "pattern": ".*", "type": "string", "example": "src/components" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactVersionContentView" }, "examples": { "Directory listing": { "summary": "Get directory contents", "description": "Directory listing", "value": { "url": "https://api.buddy.works/workspaces/ttests/artifacts/x5169jL2/versions/a9f84k2L/content/src/components", "html_url": "https://app.buddy.works/ttests/-/artifacts/x5169jL2/versions/a9f84k2L/content/src/components", "contents": [ { "url": "https://api.buddy.works/workspaces/ttests/artifacts/x5169jL2/versions/a9f84k2L/content/src/components/Button.js", "html_url": "https://app.buddy.works/ttests/-/artifacts/x5169jL2/versions/a9f84k2L/content/src/components/Button.js", "type": "FILE", "name": "Button.js", "path": "src/components/Button.js", "size": 1024 }, { "url": "https://api.buddy.works/workspaces/ttests/artifacts/x5169jL2/versions/a9f84k2L/content/src/components/Header.tsx", "html_url": "https://app.buddy.works/ttests/-/artifacts/x5169jL2/versions/a9f84k2L/content/src/components/Header.tsx", "type": "FILE", "name": "Header.tsx", "path": "src/components/Header.tsx", "size": 2560 }, { "url": "https://api.buddy.works/workspaces/ttests/artifacts/x5169jL2/versions/a9f84k2L/content/src/components/styles", "html_url": "https://app.buddy.works/ttests/-/artifacts/x5169jL2/versions/a9f84k2L/content/src/components/styles", "type": "DIR", "name": "styles", "path": "src/components/styles" } ] } }, "File metadata": { "summary": "Get file metadata", "description": "File metadata", "value": { "url": "https://api.buddy.works/workspaces/ttests/artifacts/x5169jL2/versions/a9f84k2L/content?path=/dir/README.md", "html_url": "https://app.buddy.works/ttests/-/artifacts/x5169jL2/versions/a9f84k2L/content/README.md", "contents": [ { "url": "https://api.buddy.works/workspaces/ttests/artifacts/x5169jL2/versions/a9f84k2L/content?path=/dir/README.md", "html_url": "https://app.buddy.works/ttests/-/artifacts/x5169jL2/versions/a9f84k2L/content/README.md", "type": "FILE", "size": 2048, "name": "README.md", "path": "/dir/README.md" } ] } } } } } } }, "security": [ { "oauth2": [ "ARTIFACT_READ" ] } ] }, "post": { "tags": [ "Artifact Versions API" ], "summary": "Create new directory in artifact version", "operationId": "createArtifactVersionDirectory", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "artifactId", "in": "path", "description": "The Artifact ID", "required": true, "schema": { "type": "string", "example": "x5169jL2" } }, { "name": "versionId", "in": "path", "description": "The Version ID", "required": true, "schema": { "type": "string", "example": "a9f84k2L" } }, { "name": "path", "in": "path", "description": "Path where the directory should be created", "required": true, "schema": { "pattern": ".*", "type": "string", "example": "src/components" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactVersionContentItem" }, "example": { "url": "https://api.buddy.works/workspaces/ttests/artifacts/x5169jL2/versions/a9f84k2L/content/src/components", "html_url": "https://app.buddy.works/ttests/-/artifacts/x5169jL2/versions/a9f84k2L/content/src/components", "type": "DIR", "name": "components", "path": "src/components" } } } }, "409": { "content": { "application/json": { "example": { "error": "Directory already exists", "message": "Directory 'src/components' already exists in artifact version" } } } } }, "security": [ { "oauth2": [ "ARTIFACT_WRITE" ] } ] }, "delete": { "tags": [ "Artifact Versions API" ], "summary": "Delete a file or directory", "operationId": "deleteArtifactVersionContent", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "artifactId", "in": "path", "description": "The Artifact ID", "required": true, "schema": { "type": "string", "example": "x5169jL2" } }, { "name": "versionId", "in": "path", "description": "The Version ID", "required": true, "schema": { "type": "string", "example": "a9f84k2L" } }, { "name": "path", "in": "path", "description": "Path to the file or directory to delete", "required": true, "schema": { "pattern": ".*", "type": "string", "example": "src/components" } } ], "responses": { "204": { "description": "File or directory deleted successfully" } }, "security": [ { "oauth2": [ "ARTIFACT_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/artifacts/{artifactId}/versions/{versionId}/content/download/{path}": { "get": { "tags": [ "Artifact Versions API" ], "summary": "Download file content", "operationId": "downloadArtifactVersionFile", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "artifactId", "in": "path", "description": "The Artifact ID", "required": true, "schema": { "type": "string", "example": "x5169jL2" } }, { "name": "versionId", "in": "path", "description": "The Version ID", "required": true, "schema": { "type": "string", "example": "a9f84k2L" } }, { "name": "path", "in": "path", "description": "Path to the file to download", "required": true, "schema": { "pattern": ".*", "type": "string", "example": "src/main.js" } } ], "responses": { "200": { "content": { "application/octet-stream": { "example": "(binary file content)" }, "application/json": { "schema": { "$ref": "#/components/schemas/Response" } } } } }, "security": [ { "oauth2": [ "ARTIFACT_READ" ] } ] } }, "/workspaces/{workspace_domain}/artifacts/{artifactId}/versions/{versionId}/content/upload/{path}": { "post": { "tags": [ "Artifact Versions API" ], "summary": "Upload file to artifact version", "operationId": "uploadArtifactVersionFile", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "artifactId", "in": "path", "description": "The Artifact ID", "required": true, "schema": { "type": "string", "example": "x5169jL2" } }, { "name": "versionId", "in": "path", "description": "The Version ID", "required": true, "schema": { "type": "string", "example": "a9f84k2L" } }, { "name": "path", "in": "path", "description": "Path where the file should be created", "required": true, "schema": { "pattern": ".*", "type": "string", "example": "src/main.js" } } ], "requestBody": { "description": "File to upload", "content": { "multipart/form-data": { "schema": { "type": "string", "format": "binary" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactVersionContentItem" }, "example": { "url": "https://api.buddy.works/workspaces/ttests/artifacts/x5169jL2/versions/a9f84k2L/content/src/app.js", "html_url": "https://app.buddy.works/ttests/-/artifacts/x5169jL2/versions/a9f84k2L/content/src/app.js", "type": "FILE", "name": "app.js", "path": "src/app.js", "size": 2048576 } } } } }, "security": [ { "oauth2": [ "ARTIFACT_WRITE" ] } ] } }, "/workspaces/{workspace_domain}/artifacts/{artifactId}/versions/{versionId}/download": { "get": { "tags": [ "Artifact Versions API" ], "summary": "Download artifact version as ZIP", "operationId": "downloadArtifactVersion", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "artifactId", "in": "path", "description": "The Artifact ID", "required": true, "schema": { "type": "string", "example": "x5169jL2" } }, { "name": "versionId", "in": "path", "description": "The Version ID", "required": true, "schema": { "type": "string", "example": "a9f84k2L" } } ], "responses": { "200": { "content": { "application/zip": { "example": "(binary zip archive content)" }, "application/json": { "schema": { "$ref": "#/components/schemas/Response" } } } } }, "security": [ { "oauth2": [ "ARTIFACT_READ" ] } ] } }, "/workspaces/{workspace_domain}/artifacts/{artifactId}/versions/{versionId}/upload": { "post": { "tags": [ "Artifact Versions API" ], "summary": "Upload artifact version from ZIP archive", "operationId": "uploadArtifactVersionFromZip", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "artifactId", "in": "path", "description": "The Artifact ID", "required": true, "schema": { "type": "string", "example": "x5169jL2" } }, { "name": "versionId", "in": "path", "description": "The Version ID", "required": true, "schema": { "type": "string", "example": "a9f84k2L" } } ], "requestBody": { "description": "ZIP file to upload", "content": { "multipart/form-data": { "schema": { "type": "string", "format": "binary" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactVersionView" }, "example": { "url": "https://api.buddy.works/workspaces/ttests/artifacts/x5169jL2/versions/a9f84k2L", "html_url": "https://app.buddy.works/ttests/-/artifacts/x5169jL2/versions/a9f84k2L", "extracted_files": 25, "total_size": 10485760 } } } }, "409": { "content": { "application/json": { "example": { "error": "ArtifactNotEmpty", "message": "Cannot upload ZIP to non-empty artifact version. Artifact already contains files." } } } } }, "security": [ { "oauth2": [ "ARTIFACT_WRITE" ] } ] } }, "/workspaces/{workspace_domain}/disable-sso": { "post": { "tags": [ "Workspace API" ], "summary": "Disable SSO for the workspace", "operationId": "disableSSO", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } } ], "responses": { "200": { "description": "SSO disabled successfully" } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] } }, "/workspaces/{workspace_domain}/distributions": { "get": { "tags": [ "Distribution API" ], "summary": "Get all distributions in the workspace", "operationId": "getDistributions", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "query", "description": "Project name to filter distributions", "schema": { "type": "string", "example": "my-project" } }, { "name": "environment_id", "in": "query", "description": "Environment ID to filter distributions", "schema": { "type": "string", "example": "3a4KbBQl" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DistributionsView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/distributions", "html_url": "https://app.buddy.works/my-workspace/-/routing", "distributions": [ { "url": "https://api.buddy.works/workspaces/my-workspace/distributions/rm1P93jG", "html_url": "https://app.buddy.works/my-workspace/-/routing/rm1P93jG/routes", "id": "rm1P93jG", "identifier": "test", "name": "test", "disabled": false } ] } } } } }, "security": [ { "oauth2": [ "DISTRIBUTION_INFO" ] } ] }, "post": { "tags": [ "Distribution API" ], "summary": "Create a new distribution", "operationId": "addDistribution", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDistributionRequest" }, "examples": { "Create a new distribution in a workspace": { "description": "Create a new distribution in a workspace", "value": { "name": "My Distribution", "scope": "WORKSPACE", "identifier": "my-distribution" } }, "Create a new distribution in a project": { "description": "Create a new distribution in a project", "value": { "name": "My Distribution", "scope": "PROJECT", "identifier": "my-distribution", "project_name": "my-project" } }, "Create a new distribution in an environment": { "description": "Create a new distribution in an environment", "value": { "name": "My Distribution", "scope": "ENVIRONMENT", "identifier": "my-distribution", "environment_id": "3a4KbBQl" } } } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DistributionView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/distributions/rm1P93jG", "html_url": "https://app.buddy.works/my-workspace/-/routing/rm1P93jG/routes", "id": "rm1P93jG", "identifier": "test", "name": "test", "disabled": false, "scope": "WORKSPACE", "routes": [ { "url": "https://api.buddy.works/workspaces/my-workspace/distributions/rm1P93jG/routes/1ObP9zw8", "html_url": "https://app.buddy.works/my-workspace/-/routing/rm1P93jG/route/1ObP9zw8", "id": "1ObP9zw8", "type": "PROXY", "subdomain": "testing3", "domain": "buddy.works", "path": "", "targets": { "Default": { "type": "EXTERNAL", "external_url": "kordos.com" } } }, { "url": "https://api.buddy.works/workspaces/my-workspace/distributions/rm1P93jG/routes/VXb2ZOb3", "html_url": "https://app.buddy.works/my-workspace/-/routing/rm1P93jG/route/VXb2ZOb3", "id": "VXb2ZOb3", "type": "PROXY", "subdomain": "tunnel", "domain": "buddy.works", "path": "", "targets": { "Default": { "type": "TUNNEL", "tunnel": { "id": "bartshoot", "tunnel_id": "test" } } } }, { "url": "https://api.buddy.works/workspaces/my-workspace/distributions/rm1P93jG/routes/JqbOmp06", "html_url": "https://app.buddy.works/my-workspace/-/routing/rm1P93jG/route/JqbOmp06", "id": "JqbOmp06", "type": "PROXY", "subdomain": "asdf", "domain": "buddy.works", "path": "asd", "targets": { "COUNTRY-PL": { "type": "EXTERNAL", "external_url": "testpl.com" }, "CONTINENT-Europe": { "type": "EXTERNAL", "external_url": "testeu.com" }, "Default": { "type": "EXTERNAL", "external_url": "test.com" } } } ], "permissions": { "others": "READ_ONLY", "users": [ { "id": 1, "access_level": "MANAGE" } ] } } } } } }, "security": [ { "oauth2": [ "DISTRIBUTION_ADD" ] } ] } }, "/workspaces/{workspace_domain}/distributions/{distribution_id}": { "get": { "tags": [ "Distribution API" ], "summary": "Get a specific distribution by ID", "operationId": "getDistribution", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "distribution_id", "in": "path", "description": "The ID of the distribution", "required": true, "schema": { "type": "string", "example": "nZrnl40Y" } }, { "name": "project_name", "in": "query", "description": "Project name to filter distributions", "schema": { "type": "string", "example": "my-project" } }, { "name": "environment_id", "in": "query", "description": "Environment ID to filter distributions", "schema": { "type": "string", "example": "3a4KbBQl" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DistributionView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/distributions/rm1P93jG", "html_url": "https://app.buddy.works/my-workspace/-/routing/rm1P93jG/routes", "id": "rm1P93jG", "identifier": "test", "name": "test", "disabled": false, "scope": "WORKSPACE", "routes": [ { "url": "https://api.buddy.works/workspaces/my-workspace/distributions/rm1P93jG/routes/1ObP9zw8", "html_url": "https://app.buddy.works/my-workspace/-/routing/rm1P93jG/route/1ObP9zw8", "id": "1ObP9zw8", "type": "PROXY", "subdomain": "testing3", "domain": "buddy.works", "path": "", "targets": { "Default": { "type": "EXTERNAL", "external_url": "kordos.com" } } }, { "url": "https://api.buddy.works/workspaces/my-workspace/distributions/rm1P93jG/routes/VXb2ZOb3", "html_url": "https://app.buddy.works/my-workspace/-/routing/rm1P93jG/route/VXb2ZOb3", "id": "VXb2ZOb3", "type": "PROXY", "subdomain": "tunnel", "domain": "buddy.works", "path": "", "targets": { "Default": { "type": "TUNNEL", "tunnel": { "id": "bartshoot", "tunnel_id": "test" } } } }, { "url": "https://api.buddy.works/workspaces/my-workspace/distributions/rm1P93jG/routes/JqbOmp06", "html_url": "https://app.buddy.works/my-workspace/-/routing/rm1P93jG/route/JqbOmp06", "id": "JqbOmp06", "type": "PROXY", "subdomain": "asdf", "domain": "buddy.works", "path": "asd", "targets": { "COUNTRY-PL": { "type": "EXTERNAL", "external_url": "testpl.com" }, "CONTINENT-Europe": { "type": "EXTERNAL", "external_url": "testeu.com" }, "Default": { "type": "EXTERNAL", "external_url": "test.com" } } } ], "permissions": { "others": "READ_ONLY", "users": [ { "id": 1, "access_level": "MANAGE" } ] } } } } } }, "security": [ { "oauth2": [ "DISTRIBUTION_INFO" ] } ] }, "delete": { "tags": [ "Distribution API" ], "summary": "Delete a distribution", "operationId": "deleteDistribution", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "distribution_id", "in": "path", "description": "The ID of the distribution", "required": true, "schema": { "type": "string", "example": "nZrnl40Y" } }, { "name": "project_name", "in": "query", "description": "Project name to filter distributions", "schema": { "type": "string", "example": "my-project" } }, { "name": "environment_id", "in": "query", "description": "Environment ID to filter distributions", "schema": { "type": "string", "example": "3a4KbBQl" } } ], "responses": { "204": { "description": "Distribution deleted successfully" } }, "security": [ { "oauth2": [ "DISTRIBUTION_MANAGE" ] } ] }, "patch": { "tags": [ "Distribution API" ], "summary": "Update distribution configuration", "operationId": "updateDistribution", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "distribution_id", "in": "path", "description": "The ID of the distribution", "required": true, "schema": { "type": "string", "example": "nZrnl40Y" } }, { "name": "project_name", "in": "query", "description": "Project name to filter distributions", "schema": { "type": "string", "example": "my-project" } }, { "name": "environment_id", "in": "query", "description": "Environment ID to filter distributions", "schema": { "type": "string", "example": "3a4KbBQl" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDistributionRequest" }, "examples": { "Update distribution": { "description": "Update distribution", "value": { "name": "Updated Distribution", "identifier": "updated-distribution" } }, "Disable distribution": { "description": "Disable distribution", "value": { "disabled": true } } } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DistributionView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/distributions/rm1P93jG", "html_url": "https://app.buddy.works/my-workspace/-/routing/rm1P93jG/routes", "id": "rm1P93jG", "identifier": "test", "name": "test", "disabled": false, "scope": "WORKSPACE", "routes": [ { "url": "https://api.buddy.works/workspaces/my-workspace/distributions/rm1P93jG/routes/1ObP9zw8", "html_url": "https://app.buddy.works/my-workspace/-/routing/rm1P93jG/route/1ObP9zw8", "id": "1ObP9zw8", "type": "PROXY", "subdomain": "testing3", "domain": "buddy.works", "path": "", "targets": { "Default": { "type": "EXTERNAL", "external_url": "kordos.com" } } }, { "url": "https://api.buddy.works/workspaces/my-workspace/distributions/rm1P93jG/routes/VXb2ZOb3", "html_url": "https://app.buddy.works/my-workspace/-/routing/rm1P93jG/route/VXb2ZOb3", "id": "VXb2ZOb3", "type": "PROXY", "subdomain": "tunnel", "domain": "buddy.works", "path": "", "targets": { "Default": { "type": "TUNNEL", "tunnel": { "id": "bartshoot", "tunnel_id": "test" } } } }, { "url": "https://api.buddy.works/workspaces/my-workspace/distributions/rm1P93jG/routes/JqbOmp06", "html_url": "https://app.buddy.works/my-workspace/-/routing/rm1P93jG/route/JqbOmp06", "id": "JqbOmp06", "type": "PROXY", "subdomain": "asdf", "domain": "buddy.works", "path": "asd", "targets": { "COUNTRY-PL": { "type": "EXTERNAL", "external_url": "testpl.com" }, "CONTINENT-Europe": { "type": "EXTERNAL", "external_url": "testeu.com" }, "Default": { "type": "EXTERNAL", "external_url": "test.com" } } } ], "permissions": { "others": "READ_ONLY", "users": [ { "id": 1, "access_level": "MANAGE" } ] } } } } } }, "security": [ { "oauth2": [ "DISTRIBUTION_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/distributions/{distribution_id}/routable-domains": { "get": { "tags": [ "Distribution API" ], "summary": "Get domains routable to a distribution", "operationId": "getRoutableDomains", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "distribution_id", "in": "path", "description": "The ID of the distribution", "required": true, "schema": { "type": "string", "example": "nZrnl40Y" } }, { "name": "project_name", "in": "query", "description": "Project name to filter distributions", "schema": { "type": "string", "example": "my-project" } }, { "name": "environment_id", "in": "query", "description": "Environment ID to filter distributions", "schema": { "type": "string", "example": "3a4KbBQl" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutableDomainsView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/distributions/rm1P93jG/routable-domains", "routable_domains": [ { "domain": "buddy.works", "type": "INTERNAL", "zone_id": null }, { "domain": "example.com", "type": "CLAIMED", "zone_id": "1ObP9zw8" } ] } } } } }, "security": [ { "oauth2": [ "DISTRIBUTION_INFO" ] } ] } }, "/workspaces/{workspace_domain}/distributions/{distribution_id}/routes": { "get": { "tags": [ "Route API" ], "summary": "Get all routes in the distribution", "operationId": "getRoutes", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "distribution_id", "in": "path", "description": "The ID of the distribution", "required": true, "schema": { "type": "string", "example": "nZrnl40Y" } }, { "name": "project_name", "in": "query", "description": "Project name to filter distributions", "schema": { "type": "string", "example": "my-project" } }, { "name": "environment_id", "in": "query", "description": "Environment ID to filter distributions", "schema": { "type": "string", "example": "3a4KbBQl" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/distributions/rm1P93jG/routes", "html_url": "https://app.buddy.works/my-workspace/-/routing/rm1P93jG", "routes": [ { "url": "https://api.buddy.works/workspaces/my-workspace/distributions/rm1P93jG/routes/VXb2ZOb3", "html_url": "https://app.buddy.works/my-workspace/-/routing/rm1P93jG/route/VXb2ZOb3", "id": "VXb2ZOb3", "type": "PROXY", "subdomain": "tunnel", "domain": "buddy.works", "path": "", "targets": { "Default": { "type": "TUNNEL", "tunnel": { "id": "bartshoot", "tunnel_id": "test" } } } }, { "url": "https://api.buddy.works/workspaces/my-workspace/distributions/rm1P93jG/routes/JqbOmp06", "html_url": "https://app.buddy.works/my-workspace/-/routing/rm1P93jG/route/JqbOmp06", "id": "JqbOmp06", "type": "PROXY", "subdomain": "asdf", "domain": "buddy.works", "path": "asd", "targets": { "COUNTRY-PL": { "type": "EXTERNAL", "external_url": "testpl.com" }, "CONTINENT-Europe": { "type": "EXTERNAL", "external_url": "testeu.com" }, "Default": { "type": "EXTERNAL", "external_url": "test.com" } } }, { "url": "https://api.buddy.works/workspaces/my-workspace/distributions/rm1P93jG/routes/1ObP9zw8", "html_url": "https://app.buddy.works/my-workspace/-/routing/rm1P93jG/route/1ObP9zw8", "id": "1ObP9zw8", "type": "PROXY", "subdomain": "testing3", "domain": "buddy.works", "path": "", "targets": { "Default": { "type": "EXTERNAL", "external_url": "kordos.com" } } } ] } } } } }, "security": [ { "oauth2": [ "DISTRIBUTION_INFO" ] } ] }, "post": { "tags": [ "Route API" ], "summary": "Create a new route", "operationId": "addRoute", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "distribution_id", "in": "path", "description": "The ID of the distribution", "required": true, "schema": { "type": "string", "example": "nZrnl40Y" } }, { "name": "project_name", "in": "query", "description": "Project name to filter distributions", "schema": { "type": "string", "example": "my-project" } }, { "name": "environment_id", "in": "query", "description": "Environment ID to filter distributions", "schema": { "type": "string", "example": "3a4KbBQl" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateRouteRequest" }, "examples": { "Create a route with external target": { "description": "Create a route with external target", "value": { "type": "PROXY", "subdomain": "api", "targets": { "default": { "type": "EXTERNAL", "external_url": "https://example.com" } } } }, "Create a route with artifact target": { "description": "Create a route with artifact target", "value": { "type": "PROXY", "subdomain": "app", "targets": { "default": { "type": "ARTIFACT", "artifact": { "id": "P41GZ4jq", "version_id": "pzR3j3gN" } } } } }, "Create a route with sandbox target": { "description": "Create a route with sandbox target", "value": { "type": "PROXY", "subdomain": "preview", "targets": { "default": { "type": "SANDBOX", "sandbox": { "id": "ynjuqe2kov258", "endpoint": "www" } } } } }, "Create a route with tunnel target": { "description": "Create a route with tunnel target", "value": { "type": "PROXY", "subdomain": "dev", "targets": { "default": { "type": "TUNNEL", "tunnel": { "id": "yZ8xW7vU", "tunnel_id": "rS5tP4oN" } } } } } } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RouteView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/distributions/gNYmaWYw/routes/dybEM2bg?project_name=my-project", "html_url": "https://app.buddy.works/my-workspace/my-project/routing/gNYmaWYw/route/dybEM2bg", "id": "dybEM2bg", "type": "PROXY", "subdomain": "sandbox", "domain": "buddy.works", "path": "", "targets": { "Default": { "type": "SANDBOX", "sandbox": { "id": "ynjuqe2kov258", "endpoint": "www" } } } } } } } }, "security": [ { "oauth2": [ "DISTRIBUTION_ADD" ] } ] } }, "/workspaces/{workspace_domain}/distributions/{distribution_id}/routes/{route_id}": { "get": { "tags": [ "Route API" ], "summary": "Get a specific route by ID", "operationId": "getRoute", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "distribution_id", "in": "path", "description": "The ID of the distribution", "required": true, "schema": { "type": "string", "example": "nZrnl40Y" } }, { "name": "route_id", "in": "path", "description": "The ID of the route", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "project_name", "in": "query", "description": "Project name to filter distributions", "schema": { "type": "string", "example": "my-project" } }, { "name": "environment_id", "in": "query", "description": "Environment ID to filter distributions", "schema": { "type": "string", "example": "3a4KbBQl" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RouteView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/distributions/gNYmaWYw/routes/dybEM2bg?project_name=my-project", "html_url": "https://app.buddy.works/my-workspace/my-project/routing/gNYmaWYw/route/dybEM2bg", "id": "dybEM2bg", "type": "PROXY", "subdomain": "sandbox", "domain": "buddy.works", "path": "", "targets": { "Default": { "type": "SANDBOX", "sandbox": { "id": "ynjuqe2kov258", "endpoint": "www" } } } } } } } }, "security": [ { "oauth2": [ "DISTRIBUTION_INFO" ] } ] }, "delete": { "tags": [ "Route API" ], "summary": "Delete a route", "operationId": "deleteRoute", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "distribution_id", "in": "path", "description": "The ID of the distribution", "required": true, "schema": { "type": "string", "example": "nZrnl40Y" } }, { "name": "route_id", "in": "path", "description": "The ID of the route", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "project_name", "in": "query", "description": "Project name to filter distributions", "schema": { "type": "string", "example": "my-project" } }, { "name": "environment_id", "in": "query", "description": "Environment ID to filter distributions", "schema": { "type": "string", "example": "3a4KbBQl" } } ], "responses": { "204": { "description": "Route deleted successfully" } }, "security": [ { "oauth2": [ "DISTRIBUTION_MANAGE" ] } ] }, "patch": { "tags": [ "Route API" ], "summary": "Update route configuration", "operationId": "updateRoute", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "distribution_id", "in": "path", "description": "The ID of the distribution", "required": true, "schema": { "type": "string", "example": "nZrnl40Y" } }, { "name": "route_id", "in": "path", "description": "The ID of the route", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "project_name", "in": "query", "description": "Project name to filter distributions", "schema": { "type": "string", "example": "my-project" } }, { "name": "environment_id", "in": "query", "description": "Environment ID to filter distributions", "schema": { "type": "string", "example": "3a4KbBQl" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateRouteRequest" }, "examples": { "Update route configuration": { "description": "Update route configuration", "value": { "subdomain": "updated-api", "targets": { "default": { "type": "EXTERNAL", "external_url": "https://updated.example.com" } } } } } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RouteView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/distributions/gNYmaWYw/routes/dybEM2bg?project_name=my-project", "html_url": "https://app.buddy.works/my-workspace/my-project/routing/gNYmaWYw/route/dybEM2bg", "id": "dybEM2bg", "type": "PROXY", "subdomain": "sandbox", "domain": "buddy.works", "path": "", "targets": { "Default": { "type": "SANDBOX", "sandbox": { "id": "ynjuqe2kov258", "endpoint": "www" } } } } } } } }, "security": [ { "oauth2": [ "DISTRIBUTION_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/domains": { "get": { "tags": [ "Domains API" ], "summary": "Get all domains in the workspace", "operationId": "getDomains", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainsView" }, "example": { "url": "https://api.buddy.works/workspaces/my-company/domains", "html_url": "https://app.buddy.works/my-company/-/domains", "domains": [ { "url": "https://api.buddy.works/workspaces/my-company/domains/4krmDRPw", "html_url": "https://app.buddy.works/my-company/-/domain/4krmDRPw", "id": "4krmDRPw", "name": "example.com" }, { "url": "https://api.buddy.works/workspaces/my-company/domains/z2Qb9p03", "html_url": "https://app.buddy.works/my-company/-/domain/z2Qb9p03", "id": "z2Qb9p03", "name": "myproject.org" }, { "url": "https://api.buddy.works/workspaces/my-company/domains/jBQ19Qya", "html_url": "https://app.buddy.works/my-company/-/domain/jBQ19Qya", "id": "jBQ19Qya", "name": "testdomain.net" } ] } } } } }, "security": [ { "oauth2": [ "ZONE_READ" ] } ] } }, "/workspaces/{workspace_domain}/domains/{id}": { "get": { "tags": [ "Domains API" ], "summary": "Get a specific domain by name", "operationId": "getDomain", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "id", "in": "path", "description": "The ID of the domain", "required": true, "schema": { "type": "string", "example": "4krmDRPw" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainView" }, "examples": { "Registered Domain": { "description": "Registered Domain", "value": { "url": "https://api.buddy.works/workspaces/my-company/domains/4krmDRPw", "html_url": "https://app.buddy.works/my-company/-/domain/4krmDRPw", "id": "4krmDRPw", "name": "example.com", "type": "REGISTERED", "auto_renew": true, "transfer_lock": true, "dnssec": false, "expiry_date": "2026-09-26T19:30:18Z" } }, "Pointed Domain": { "description": "Pointed Domain", "value": { "url": "https://api.buddy.works/workspaces/my-company/domains/z2Qb9p03", "html_url": "https://app.buddy.works/my-company/-/domain/z2Qb9p03", "id": "z2Qb9p03", "name": "pointed.com", "type": "POINTED", "pointed_via": [ "NS" ] } }, "Claimed Domain": { "description": "Claimed Domain", "value": { "url": "https://api.buddy.works/workspaces/my-company/domains/WEQgvpvg", "html_url": "https://app.buddy.works/my-company/-/domain/WEQgvpvg", "id": "WEQgvpvg", "name": "claim.claimable.com", "type": "CLAIMED" } } } } } } }, "security": [ { "oauth2": [ "ZONE_READ" ] } ] } }, "/workspaces/{workspace_domain}/domains/{domain_id}/records": { "get": { "tags": [ "Domains API" ], "summary": "Get all records for domain", "operationId": "getAllDomainRecords", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "domain_id", "in": "path", "description": "The ID of the domain", "required": true, "schema": { "type": "string", "example": "4krmDRPw" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordsView" }, "examples": { "Records List": { "description": "Records List", "value": { "url": "https://api.buddy.works/workspaces/my-company/domains/4krmDRPw/records", "html_url": "https://app.buddy.works/my-company/-/domain/4krmDRPw", "records": [ { "url": "https://api.buddy.works/workspaces/my-company/domains/4krmDRPw/records/example.com./SOA", "html_url": "https://app.buddy.works/my-company/-/domain/4krmDRPw", "type": "SOA", "name": "@" }, { "url": "https://api.buddy.works/workspaces/my-company/domains/4krmDRPw/records/example.com./NS", "html_url": "https://app.buddy.works/my-company/-/domain/4krmDRPw", "type": "NS", "name": "@" }, { "url": "https://api.buddy.works/workspaces/my-company/domains/4krmDRPw/records/www.example.com./A", "html_url": "https://app.buddy.works/my-company/-/domain/4krmDRPw", "type": "A", "name": "www" }, { "url": "https://api.buddy.works/workspaces/my-company/domains/4krmDRPw/records/api.example.com./A", "html_url": "https://app.buddy.works/my-company/-/domain/4krmDRPw", "type": "A", "name": "api" }, { "url": "https://api.buddy.works/workspaces/my-company/domains/4krmDRPw/records/blog.example.com./CNAME", "html_url": "https://app.buddy.works/my-company/-/domain/4krmDRPw", "type": "CNAME", "name": "blog" } ] } } } } } } }, "security": [ { "oauth2": [ "ZONE_READ" ] } ] } }, "/workspaces/{workspace_domain}/domains/{domain_id}/records/{record_name}": { "get": { "tags": [ "Domains API" ], "summary": "Get all records for domain or subdomain", "operationId": "getSubdomainRecords", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "domain_id", "in": "path", "description": "The ID of the domain", "required": true, "schema": { "type": "string", "example": "4krmDRPw" } }, { "name": "record_name", "in": "path", "description": "The full record name with domain", "required": true, "schema": { "type": "string", "example": "api.example.com" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordsView" }, "examples": { "Records List": { "description": "When providing base domain name like `example.com` you see all records for the domain.", "value": { "url": "https://api.buddy.works/workspaces/my-company/domains/4krmDRPw/records", "html_url": "https://app.buddy.works/my-company/-/domain/4krmDRPw", "records": [ { "url": "https://api.buddy.works/workspaces/my-company/domains/4krmDRPw/records/example.com./SOA", "html_url": "https://app.buddy.works/my-company/-/domain/4krmDRPw", "type": "SOA", "name": "@" }, { "url": "https://api.buddy.works/workspaces/my-company/domains/4krmDRPw/records/example.com./NS", "html_url": "https://app.buddy.works/my-company/-/domain/4krmDRPw", "type": "NS", "name": "@" }, { "url": "https://api.buddy.works/workspaces/my-company/domains/4krmDRPw/records/www.example.com./A", "html_url": "https://app.buddy.works/my-company/-/domain/4krmDRPw", "type": "A", "name": "www" }, { "url": "https://api.buddy.works/workspaces/my-company/domains/4krmDRPw/records/api.example.com./A", "html_url": "https://app.buddy.works/my-company/-/domain/4krmDRPw", "type": "A", "name": "api" }, { "url": "https://api.buddy.works/workspaces/my-company/domains/4krmDRPw/records/blog.example.com./CNAME", "html_url": "https://app.buddy.works/my-company/-/domain/4krmDRPw", "type": "CNAME", "name": "blog" } ] } }, "Partial Records List": { "description": "When providing subdomain like `api.example.com` you see only records for that subdomain.", "value": { "url": "https://api.buddy.works/workspaces/my-company/domains/4krmDRPw/records", "html_url": "https://app.buddy.works/my-company/-/domain/4krmDRPw", "records": [ { "url": "https://api.buddy.works/workspaces/my-company/domains/4krmDRPw/records/api.example.com./A", "html_url": "https://app.buddy.works/my-company/-/domain/4krmDRPw", "type": "A", "name": "api" } ] } }, "No Records List": { "description": "When providing domain with subdomain where no records exist like `second.api.example.com`, the list is empty.", "value": { "url": "https://api.buddy.works/workspaces/my-company/domains/4krmDRPw/records", "html_url": "https://app.buddy.works/my-company/-/domain/4krmDRPw", "records": [] } } } } } } }, "security": [ { "oauth2": [ "ZONE_READ" ] } ] } }, "/workspaces/{workspace_domain}/domains/{domain_id}/records/{record_name}/{type}": { "get": { "tags": [ "Domains API" ], "summary": "Get one record by type", "operationId": "getDomainRecord", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "domain_id", "in": "path", "description": "The ID of the domain", "required": true, "schema": { "type": "string", "example": "4krmDRPw" } }, { "name": "record_name", "in": "path", "description": "The full record name with domain", "required": true, "schema": { "type": "string", "example": "api.example.com" } }, { "name": "type", "in": "path", "description": "The record type", "required": true, "schema": { "type": "string", "example": "A", "enum": [ "SOA", "NS", "A", "AAAA", "CNAME", "ALIAS", "CAA", "SPF", "MX", "TXT", "SRV", "NAPTR", "PTR" ] } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordView" }, "examples": { "A Record": { "description": "A Record", "value": { "url": "https://api.buddy.works/workspaces/my-company/domains/4krmDRPw/records/example.com./A", "html_url": "https://app.buddy.works/my-company/-/domain/4krmDRPw", "name": "@", "type": "A", "values": [ "192.168.1.100", "192.168.1.101" ], "ttl": 300, "routing": "simple" } }, "CNAME Record": { "description": "CNAME Record", "value": { "url": "https://api.buddy.works/workspaces/my-company/domains/4krmDRPw/records/blog.example.com./CNAME", "html_url": "https://app.buddy.works/my-company/-/domain/4krmDRPw", "name": "blog", "type": "CNAME", "values": [ "target.example.com." ], "ttl": 3600, "routing": "simple" } }, "MX Record": { "description": "MX Record", "value": { "url": "https://api.buddy.works/workspaces/my-company/domains/4krmDRPw/records/example.com./MX", "html_url": "https://app.buddy.works/my-company/-/domain/4krmDRPw", "name": "@", "type": "MX", "values": [ "10 mail1.example.com.", "20 mail2.example.com." ], "ttl": 3600, "routing": "simple" } }, "TXT Record": { "description": "TXT Record", "value": { "url": "https://api.buddy.works/workspaces/my-company/domains/4krmDRPw/records/example.com./TXT", "html_url": "https://app.buddy.works/my-company/-/domain/4krmDRPw", "name": "@", "type": "TXT", "values": [ "v=spf1 include:_spf.example.com ~all", "google-site-verification=abc123def456ghi789jkl012" ], "ttl": 300, "routing": "simple", "country": null, "continent": null } }, "Geolocation Record": { "description": "Geolocation Record", "value": { "url": "https://api.buddy.works/workspaces/my-company/domains/4krmDRPw/records/api.example.com./A", "html_url": "https://app.buddy.works/my-company/-/domain/4krmDRPw", "name": "api", "type": "A", "values": [ "192.168.1.100" ], "ttl": 300, "routing": "geolocation", "country": { "US": [ "192.168.1.101", "192.168.1.102" ], "DE": [ "192.168.1.103", "192.168.1.104" ], "JP": [ "192.168.1.105" ] }, "continent": { "Europe": [ "192.168.1.110", "192.168.1.111" ], "NorthAmerica": [ "192.168.1.112", "192.168.1.113" ], "Asia": [ "192.168.1.114" ] } } } } } } } }, "security": [ { "oauth2": [ "ZONE_READ" ] } ] }, "delete": { "tags": [ "Domains API" ], "summary": "Delete record", "operationId": "deleteDomainRecord", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "domain_id", "in": "path", "description": "The ID of the domain", "required": true, "schema": { "type": "string", "example": "4krmDRPw" } }, { "name": "record_name", "in": "path", "description": "The full record name with domain", "required": true, "schema": { "type": "string", "example": "api.example.com" } }, { "name": "type", "in": "path", "description": "The record type", "required": true, "schema": { "type": "string", "example": "A", "enum": [ "SOA", "NS", "A", "AAAA", "CNAME", "ALIAS", "CAA", "SPF", "MX", "TXT", "SRV", "NAPTR", "PTR" ] } } ], "responses": { "204": { "description": "Record deleted successfully" } }, "security": [ { "oauth2": [ "ZONE_WRITE" ] } ] }, "patch": { "tags": [ "Domains API" ], "summary": "Create or update record", "operationId": "upsertDomainRecord", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "domain_id", "in": "path", "description": "The ID of the domain", "required": true, "schema": { "type": "string", "example": "4krmDRPw" } }, { "name": "record_name", "in": "path", "description": "The full record name with domain", "required": true, "schema": { "type": "string", "example": "api.example.com" } }, { "name": "type", "in": "path", "description": "The record type", "required": true, "schema": { "type": "string", "example": "A", "enum": [ "SOA", "NS", "A", "AAAA", "CNAME", "ALIAS", "CAA", "SPF", "MX", "TXT", "SRV", "NAPTR", "PTR" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchRecordCommand" }, "examples": { "Upsert A Record": { "description": "Upsert A Record", "value": { "values": [ "192.168.1.100", "192.168.1.101" ], "ttl": 300, "routing": "simple" } }, "Upsert CNAME Record": { "description": "Upsert CNAME Record", "value": { "values": [ "target.example.com." ], "ttl": 3600, "routing": "simple" } }, "Upsert Geolocation Record": { "description": "Upsert Geolocation Record", "value": { "values": [ "192.168.1.100" ], "ttl": 300, "routing": "geolocation", "country": { "US": [ "192.168.1.101", "192.168.1.102" ], "DE": [ "192.168.1.103", "192.168.1.104" ], "JP": [ "192.168.1.105" ] }, "continent": { "Europe": [ "192.168.1.110", "192.168.1.111" ], "NorthAmerica": [ "192.168.1.112", "192.168.1.113" ], "Asia": [ "192.168.1.114" ] } } } } } } }, "responses": { "200": { "description": "Record updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordView" }, "examples": { "Upsert A Record": { "description": "Upsert A Record", "value": { "url": "https://api.buddy.works/workspaces/my-company/domains/4krmDRPw/records/example.com./A", "html_url": "https://app.buddy.works/my-company/-/domain/4krmDRPw", "name": "@", "type": "A", "values": [ "192.168.1.100", "192.168.1.101" ], "ttl": 300, "routing": "simple" } }, "Upsert CNAME Record": { "description": "Upsert CNAME Record", "value": { "url": "https://api.buddy.works/workspaces/my-company/domains/4krmDRPw/records/blog.example.com./CNAME", "html_url": "https://app.buddy.works/my-company/-/domain/4krmDRPw", "name": "blog", "type": "CNAME", "values": [ "target.example.com." ], "ttl": 3600, "routing": "simple" } }, "Upsert Geolocation Record": { "description": "Upsert Geolocation Record", "value": { "url": "https://api.buddy.works/workspaces/my-company/domains/4krmDRPw/records/api.example.com./A", "html_url": "https://app.buddy.works/my-company/-/domain/4krmDRPw", "name": "api", "type": "A", "values": [ "192.168.1.100" ], "ttl": 300, "routing": "geolocation", "country": { "US": [ "192.168.1.101", "192.168.1.102" ], "DE": [ "192.168.1.103", "192.168.1.104" ], "JP": [ "192.168.1.105" ] }, "continent": { "Europe": [ "192.168.1.110", "192.168.1.111" ], "NorthAmerica": [ "192.168.1.112", "192.168.1.113" ], "Asia": [ "192.168.1.114" ] } } } } } } } }, "security": [ { "oauth2": [ "ZONE_WRITE" ] } ] } }, "/workspaces/{workspace_domain}/domains/claim": { "post": { "tags": [ "Domains API" ], "summary": "Claim an existing domain", "operationId": "claimDomain", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClaimDomainViewCommand" }, "examples": { "Claim Domain": { "description": "Claim Domain", "value": { "name": "mydomain.claim.net", "on_owner_behalf": false } } } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainView" }, "examples": { "Claim Domain": { "description": "Claim Domain", "value": { "url": "https://api.buddy.works/workspaces/my-company/domains/ZyQBXwrX", "html_url": "https://app.buddy.works/my-company/-/domain/ZyQBXwrX", "name": "mydomain.claim.net", "id": "ZyQBXwrX", "type": "CLAIMED" } } } } } } }, "security": [ { "oauth2": [ "ZONE_WRITE" ] } ] } }, "/workspaces/{workspace_domain}/domains/claimable/{name}": { "get": { "tags": [ "Domains API" ], "summary": "Check claimable domains availability for a subdomain name", "operationId": "checkClaimable", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "name", "in": "path", "description": "The subdomain name to search for in the list of claimable domains", "required": true, "schema": { "type": "string", "example": "food" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClaimableDomainsView" }, "examples": { "Claimable Domains": { "description": "Claimable Domains", "value": { "url": "https://api.buddy.works/workspaces/my-company/domains/claimable", "html_url": "https://app.buddy.works/my-company/-/domains/claim", "domains": [ { "url": "https://api.buddy.works/workspaces/my-company/domains/claimable", "html_url": "https://app.buddy.works/my-company/-/domains/claim", "domain": "claim.net", "available": true }, { "url": "https://api.buddy.works/workspaces/my-company/domains/claimable", "html_url": "https://app.buddy.works/my-company/-/domains/claim", "domain": "claim.app", "available": false } ] } } } } } } }, "security": [ { "oauth2": [ "ZONE_READ" ] } ] } }, "/workspaces/{workspace_domain}/domains/register": { "post": { "tags": [ "Domains API" ], "summary": "Register a new domain", "operationId": "registerDomain", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterDomainViewCommand" }, "examples": { "Register Domain": { "description": "Register Domain", "value": { "name": "testdomain.pl", "auto_renew": true, "on_owner_behalf": false } } } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainView" }, "examples": { "Register Domain": { "description": "Register Domain", "value": { "url": "https://api.buddy.works/workspaces/my-company/domains/YVpzb4p8", "html_url": "https://app.buddy.works/my-company/-/domain/YVpzb4p8", "name": "testdomain.pl", "id": "YVpzb4p8", "type": "REGISTERED", "auto_renew": true, "dnssec": false } } } } } } }, "security": [ { "oauth2": [ "ZONE_WRITE" ] } ] } }, "/workspaces/{workspace_domain}/domains/search": { "post": { "tags": [ "Domains API" ], "summary": "Search domains availability", "operationId": "searchDomainsAvailability", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainSearchCommand" }, "examples": { "Search Domains": { "description": "Search Domains", "value": { "domains": [ "mysite.org", "testdomain.org.pl", "premium-name.uno", "example.com" ] } } } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainSearchResultView" }, "examples": { "Search Domains": { "description": "Search Domains", "value": { "url": "https://api.buddy.works/workspaces/my-company/domains/search", "html_url": "https://app.buddy.works/my-company/-/domains/buy", "domains": [ { "url": "https://api.buddy.works/workspaces/my-company/domains/search", "html_url": "https://app.buddy.works/my-company/-/domains/buy", "name": "mysite.org", "available": false }, { "url": "https://api.buddy.works/workspaces/my-company/domains/search", "html_url": "https://app.buddy.works/my-company/-/domains/buy", "name": "testdomain.org.pl", "available": true, "premium": false, "prices": { "create": { "currency": "USD", "price": 4.24, "min_duration": 1, "max_duration": 10 }, "transfer": { "currency": "USD", "price": 0, "min_duration": 1, "max_duration": 1 }, "renew": { "currency": "USD", "price": 11.02, "min_duration": 1, "max_duration": 9 }, "restore": { "currency": "USD", "price": 13.85, "min_duration": 1, "max_duration": 1 } } }, { "url": "https://api.buddy.works/workspaces/my-company/domains/search", "html_url": "https://app.buddy.works/my-company/-/domains/buy", "name": "premium-name.uno", "available": true, "premium": true, "prices": { "create": { "currency": "USD", "price": 6500, "min_duration": 1, "max_duration": 10 }, "transfer": { "currency": "USD", "price": 6500, "min_duration": 1, "max_duration": 1 }, "renew": { "currency": "USD", "price": 6500, "min_duration": 1, "max_duration": 9 }, "restore": { "currency": "USD", "price": 52, "min_duration": 1, "max_duration": 1 } } }, { "url": "https://api.buddy.works/workspaces/my-company/domains/search", "html_url": "https://app.buddy.works/my-company/-/domains/buy", "name": "example.com", "available": false } ] } } } } } } }, "security": [ { "oauth2": [ "ZONE_READ" ] } ] } }, "/workspaces/{workspace_domain}/enable-sso": { "post": { "tags": [ "Workspace API" ], "summary": "Enable SSO for the workspace", "operationId": "enableSSO", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } } ], "responses": { "200": { "description": "SSO enabled successfully" } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] } }, "/workspaces/{workspace_domain}/environments": { "get": { "tags": [ "Environment API" ], "summary": "Get all environments in the workspace", "operationId": "getEnvironments", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "query", "description": "Project name to filter environments", "schema": { "type": "string", "example": "my-project" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShortEnvironmentView" }, "example": [ { "url": "https://api.buddy.works/workspaces/my-workspace/environments/123", "html_url": "https://my-workspace.buddy.works/environments/123", "id": "3a4KbBQl", "name": "Production Environment", "identifier": "prod-env", "tags": [ "production", "stable" ], "scope": "PROJECT" }, { "url": "https://api.buddy.works/workspaces/my-workspace/environments/456", "html_url": "https://my-workspace.buddy.works/environments/456", "id": "wPjWOjpE", "name": "Staging Environment", "identifier": "staging-env", "tags": [ "staging", "testing" ], "scope": "WORKSPACE" } ] } } } }, "security": [ { "oauth2": [ "ENVIRONMENT_INFO" ] } ] }, "post": { "tags": [ "Environment API" ], "summary": "Create a new environment", "operationId": "addEnvironment", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentRequest" }, "examples": { "Create a new environment in a project": { "description": "Create a new environment in a project", "value": { "name": "Production Environment", "identifier": "prod-env", "tags": [ "production", "stable" ], "icon": "production.svg", "public_url": "https://prod.example.com", "pipelines_access_level": "DENIED", "environments_access_level": "DENIED", "scope": "PROJECT", "base_only": false, "project": { "name": "my-project" }, "allowed_pipelines": [ { "project": "my-project", "pipeline": "Deploy to Production" } ], "allowed_environments": [ { "project": "my-project", "environment": "staging" } ], "base_environments": [ "staging", "development" ] } }, "Create a new environment in a workspace": { "description": "Create a new environment in a workspace", "value": { "name": "Staging Environment", "identifier": "staging-env", "tags": [ "staging", "testing" ], "icon": "staging.svg", "public_url": "https://staging.example.com", "pipelines_access_level": "READ_ONLY", "environments_access_level": "READ_ONLY", "scope": "WORKSPACE", "base_only": false, "allowed_pipelines": [ { "project": "my-project", "pipeline": "Deploy to Production" } ], "allowed_environments": [ { "project": "my-project", "environment": "staging" } ], "base_environments": [ "staging", "development" ] } } } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/environments/3a4KbBQl", "html_url": "https://my-workspace.buddy.works/environments/environment/3a4KbBQl", "id": "3a4KbBQl", "name": "Development Environment", "identifier": "dev", "tags": [ "development", "dev" ], "icon": "development.svg", "public_url": "https://env.myproduct.com", "pipelines_access_level": "DENIED", "environments_access_level": "DENIED", "allowed_pipelines": [ { "project": "my-project", "pipeline": "Deploy to Dev" } ], "allowed_environments": [ { "project": "my-project", "environment": "staging" } ], "create_date": "2024-01-15T10:30:00Z", "project": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project", "html_url": "https://my-workspace.buddy.works/projects/my-project", "name": "my-project", "display_name": "My Project" }, "permissions": { "others": "USE_ONLY", "users": [ { "id": 123, "access_level": "MANAGE" } ], "groups": [ { "id": 456, "access_level": "READ_WRITE" } ] }, "base_environments": [ "production", "staging" ], "targets": [ { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/targets/123", "html_url": "https://my-workspace.buddy.works/my-project/targets/123", "id": "abc123", "identifier": "dev-server", "type": "SSH" } ], "base_only": false, "scope": "PROJECT" } } } } }, "security": [ { "oauth2": [ "ENVIRONMENT_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/environments/{id}": { "get": { "tags": [ "Environment API" ], "summary": "Get a specific environment by ID", "operationId": "getEnvironment", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "id", "in": "path", "description": "The ID of the environment", "required": true, "schema": { "type": "string", "example": "3a4KbBQl" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/environments/3a4KbBQl", "html_url": "https://my-workspace.buddy.works/environments/environment/3a4KbBQl", "id": "3a4KbBQl", "name": "Development Environment", "identifier": "dev", "tags": [ "development", "dev" ], "icon": "development.svg", "public_url": "https://env.myproduct.com", "pipelines_access_level": "DENIED", "environments_access_level": "DENIED", "allowed_pipelines": [ { "project": "my-project", "pipeline": "Deploy to Dev" } ], "allowed_environments": [ { "project": "my-project", "environment": "staging" } ], "create_date": "2024-01-15T10:30:00Z", "project": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project", "html_url": "https://my-workspace.buddy.works/projects/my-project", "name": "my-project", "display_name": "My Project" }, "permissions": { "others": "USE_ONLY", "users": [ { "id": 123, "access_level": "MANAGE" } ], "groups": [ { "id": 456, "access_level": "READ_WRITE" } ] }, "base_environments": [ "production", "staging" ], "targets": [ { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/targets/123", "html_url": "https://my-workspace.buddy.works/my-project/targets/123", "id": "abc123", "identifier": "dev-server", "type": "SSH" } ], "base_only": false, "scope": "PROJECT" } } } } }, "security": [ { "oauth2": [ "ENVIRONMENT_INFO" ] } ] }, "delete": { "tags": [ "Environment API" ], "summary": "Delete an environment", "operationId": "deleteEnvironment", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "id", "in": "path", "description": "The ID of the environment", "required": true, "schema": { "type": "string", "example": "3a4KbBQl" } } ], "responses": { "204": { "description": "Environment deleted successfully" } }, "security": [ { "oauth2": [ "ENVIRONMENT_MANAGE" ] } ] }, "patch": { "tags": [ "Environment API" ], "summary": "Update environment configuration", "operationId": "updateEnvironment", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "id", "in": "path", "description": "The ID of the environment", "required": true, "schema": { "type": "string", "example": "3a4KbBQl" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentRequest" }, "examples": { "Update environment": { "description": "Update environment", "value": { "name": "Updated Production Environment", "identifier": "prod-env-v2", "tags": [ "production", "stable", "updated" ], "icon": "production-v2.svg", "public_url": "https://prod-v2.example.com", "pipelines_access_level": "DENIED", "environments_access_level": "DENIED" } }, "Update environment name only": { "description": "Update environment name only", "value": { "name": "Renamed Environment" } } } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/environments/3a4KbBQl", "html_url": "https://my-workspace.buddy.works/environments/environment/3a4KbBQl", "id": "3a4KbBQl", "name": "Development Environment", "identifier": "dev", "tags": [ "development", "dev" ], "icon": "development.svg", "public_url": "https://env.myproduct.com", "pipelines_access_level": "DENIED", "environments_access_level": "DENIED", "allowed_pipelines": [ { "project": "my-project", "pipeline": "Deploy to Dev" } ], "allowed_environments": [ { "project": "my-project", "environment": "staging" } ], "create_date": "2024-01-15T10:30:00Z", "project": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project", "html_url": "https://my-workspace.buddy.works/projects/my-project", "name": "my-project", "display_name": "My Project" }, "permissions": { "others": "USE_ONLY", "users": [ { "id": 123, "access_level": "MANAGE" } ], "groups": [ { "id": 456, "access_level": "READ_WRITE" } ] }, "base_environments": [ "production", "staging" ], "targets": [ { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/targets/123", "html_url": "https://my-workspace.buddy.works/my-project/targets/123", "id": "abc123", "identifier": "dev-server", "type": "SSH" } ], "base_only": false, "scope": "PROJECT" } } } } }, "security": [ { "oauth2": [ "ENVIRONMENT_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/groups": { "get": { "tags": [ "Group API" ], "summary": "Returns all groups in the workspace", "operationId": "getGroups", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupsView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/groups", "html_url": "https://app.buddy.works/my-workspace/groups", "groups": [ { "url": "https://api.buddy.works/workspaces/my-workspace/groups/123", "html_url": "https://app.buddy.works/my-workspace/-/group/123", "id": 123, "name": "developers", "description": "Development team members" }, { "url": "https://api.buddy.works/workspaces/my-workspace/groups/124", "html_url": "https://app.buddy.works/my-workspace/-/group/124", "id": 124, "name": "designers", "description": "UI/UX design team" } ] } } } } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] }, "post": { "tags": [ "Group API" ], "summary": "Creates a new group. Restricted to admins only", "operationId": "addGroup", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddGroupRequest" }, "example": { "name": "developers", "description": "Development team members", "auto_assign_to_new_projects": true, "allow_add_new_projects": false, "allow_add_new_domains_on_owner_behalf": false, "auto_assign_permission_set_id": 1 } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/groups/123", "html_url": "https://app.buddy.works/my-workspace/-/group/123", "id": 123, "name": "developers", "description": "Development team members", "auto_assign_to_new_projects": true, "allow_add_new_projects": false, "allow_add_new_domains_on_owner_behalf": false, "auto_assign_permission_set_id": 1 } } } } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] } }, "/workspaces/{workspace_domain}/groups/{id}": { "get": { "tags": [ "Group API" ], "summary": "Shows details of an user group", "operationId": "getGroup", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "id", "in": "path", "description": "The ID of the group", "required": true, "schema": { "type": "integer", "format": "int32", "example": 123 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/groups/123", "html_url": "https://app.buddy.works/my-workspace/-/group/123", "id": 123, "name": "developers", "description": "Development team members", "auto_assign_to_new_projects": true, "allow_add_new_projects": false, "allow_add_new_domains_on_owner_behalf": false, "auto_assign_permission_set_id": 1 } } } } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] }, "delete": { "tags": [ "Group API" ], "summary": "Deletes a group", "operationId": "deleteGroup", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "id", "in": "path", "description": "The ID of the group", "required": true, "schema": { "type": "integer", "format": "int32", "example": 123 } } ], "responses": { "default": { "description": "default response", "content": { "application/json": {} } } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] }, "patch": { "tags": [ "Group API" ], "summary": "Edits the properties of an existing group", "operationId": "updateGroup", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "id", "in": "path", "description": "The ID of the group", "required": true, "schema": { "type": "integer", "format": "int32", "example": 123 } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateGroupRequest" }, "example": { "name": "senior-developers", "description": "Senior development team members", "auto_assign_to_new_projects": false, "allow_add_new_projects": true, "allow_add_new_domains_on_owner_behalf": true, "auto_assign_permission_set_id": 2 } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/groups/123", "html_url": "https://app.buddy.works/my-workspace/-/group/123", "id": 123, "name": "developers", "description": "Development team members", "auto_assign_to_new_projects": true, "allow_add_new_projects": false, "allow_add_new_domains_on_owner_behalf": false, "auto_assign_permission_set_id": 1 } } } } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] } }, "/workspaces/{workspace_domain}/groups/{group_id}/members": { "get": { "tags": [ "Group API" ], "summary": "Returns all members from the group", "operationId": "getGroupMembers", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "group_id", "in": "path", "description": "The ID of the group", "required": true, "schema": { "type": "integer", "format": "int32", "example": 123 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupMembersView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/groups/123/members", "html_url": "https://app.buddy.works/my-workspace/-/people/groups", "members": [ { "url": "https://api.buddy.works/workspaces/my-workspace/groups/123/members/216", "html_url": "https://app.buddy.works/my-workspace/-/profile/216", "id": 216, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/2/1/6/avatar.png", "email": "john.doe@example.com", "admin": false, "workspace_owner": false, "status": "MEMBER" }, { "url": "https://api.buddy.works/workspaces/my-workspace/groups/123/members/215", "html_url": "https://app.buddy.works/my-workspace/-/profile/215", "id": 215, "name": "Jane Smith", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/2/1/5/avatar.png", "email": "jane.smith@example.com", "admin": true, "workspace_owner": false, "status": "MANAGER" } ] } } } } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] }, "post": { "tags": [ "Group API" ], "summary": "Adds a user to the group", "operationId": "addGroupMember", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "group_id", "in": "path", "description": "The ID of the group", "required": true, "schema": { "type": "integer", "format": "int32", "example": 123 } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddGroupMemberRequest" }, "example": { "id": 216, "status": "MEMBER" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupMemberView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/groups/123/members/216", "html_url": "https://app.buddy.works/my-workspace/-/profile/216", "id": 216, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/2/1/6/avatar.png", "email": "john.doe@example.com", "admin": false, "workspace_owner": false, "status": "MEMBER" } } } } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] } }, "/workspaces/{workspace_domain}/groups/{group_id}/members/{id}": { "get": { "tags": [ "Group API" ], "summary": "Returns a single member of a user group", "operationId": "getGroupMember", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "group_id", "in": "path", "description": "The ID of the group", "required": true, "schema": { "type": "integer", "format": "int32", "example": 123 } }, { "name": "id", "in": "path", "description": "The ID of the member", "required": true, "schema": { "type": "integer", "format": "int32", "example": 216 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupMemberView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/groups/123/members/216", "html_url": "https://app.buddy.works/my-workspace/-/profile/216", "id": 216, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/2/1/6/avatar.png", "email": "john.doe@example.com", "admin": false, "workspace_owner": false, "status": "MEMBER" } } } } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] }, "delete": { "tags": [ "Group API" ], "summary": "Deletes a member from a group", "operationId": "deleteGroupMember", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "group_id", "in": "path", "description": "The ID of the group", "required": true, "schema": { "type": "integer", "format": "int32", "example": 123 } }, { "name": "id", "in": "path", "description": "The ID of the member", "required": true, "schema": { "type": "integer", "format": "int32", "example": 216 } } ], "responses": { "default": { "description": "default response", "content": { "application/json": {} } } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] }, "patch": { "tags": [ "Group API" ], "summary": "Updates the group member's status", "operationId": "updateGroupMember", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "group_id", "in": "path", "description": "The ID of the group", "required": true, "schema": { "type": "integer", "format": "int32", "example": 123 } }, { "name": "id", "in": "path", "description": "The ID of the member", "required": true, "schema": { "type": "integer", "format": "int32", "example": 216 } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateGroupMemberRequest" }, "example": { "status": "MANAGER" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupMemberView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/groups/123/members/216", "html_url": "https://app.buddy.works/my-workspace/-/profile/216", "id": 216, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/2/1/6/avatar.png", "email": "john.doe@example.com", "admin": false, "workspace_owner": false, "status": "MEMBER" } } } } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] } }, "/workspaces/{workspace_domain}/identifiers": { "get": { "tags": [ "Workspace API" ], "summary": "Get the ID of an object using its human-readable identifier", "operationId": "getIdentifiers", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project", "in": "query", "description": "The human-readable ID of the project", "schema": { "type": "string", "example": "my-project" } }, { "name": "pipeline", "in": "query", "description": "The human-readable ID of the pipeline", "schema": { "type": "string", "example": "my-pipeline" } }, { "name": "environment", "in": "query", "description": "The human-readable ID of the environment", "schema": { "type": "string", "example": "my-environment" } }, { "name": "artifact", "in": "query", "description": "The human-readable ID of the artifact", "schema": { "type": "string", "example": "my-artifact" } }, { "name": "artifact_version", "in": "query", "description": "The version of the artifact", "schema": { "type": "string", "example": "v1" } }, { "name": "sandbox", "in": "query", "description": "The human-readable ID of the sandbox", "schema": { "type": "string", "example": "my-sandbox" } }, { "name": "unit_test_suite", "in": "query", "description": "The human-readable ID of the unit test suite", "schema": { "type": "string", "example": "my-unit-test-suite" } }, { "name": "visual_test_suite", "in": "query", "description": "The human-readable ID of the visual test suite", "schema": { "type": "string", "example": "my-visual-test-suite" } }, { "name": "crawl_suite", "in": "query", "description": "The human-readable ID of the crawl suite", "schema": { "type": "string", "example": "my-crawl-suite" } }, { "name": "distribution", "in": "query", "description": "The human-readable ID of the distribution", "schema": { "type": "string", "example": "my-distribution" } }, { "name": "route_subdomain", "in": "query", "description": "The subdomain of the route. Resolved together with route_domain and route_path against the parent distribution.", "schema": { "type": "string", "example": "api" } }, { "name": "route_domain", "in": "query", "description": "The domain of the route. Required to resolve a route.", "schema": { "type": "string", "example": "example.com" } }, { "name": "route_path", "in": "query", "description": "The path of the route. Resolved together with route_subdomain and route_domain against the parent distribution.", "schema": { "type": "string", "example": "v1" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdsView" }, "example": { "url": "https://api.buddy.works/workspaces/my-company", "domain": "my-company", "project_identifier": "my-project", "pipeline_id": 123, "environment_id": "ZRB20jX6", "artifact_id": "B81VVP1Z", "artifact_version_id": "79dMAdl0", "visual_test_suite_id": "507f1f77bcf86cd799439011", "crawl_suite_id": "507f1f77bcf86cd799439012", "distribution_id": "56a5ndQ6", "route_id": "ab9R9jPw" } } } } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] } }, "/workspaces/{workspace_domain}/integrations": { "get": { "tags": [ "Workspace API" ], "summary": "Get all integrations in the workspace", "operationId": "getIntegrations", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsView" }, "example": { "url": "https://api.buddy.works/user/integrations", "html_url": "https://app.buddy.works/toprus/-/workspace/integrations", "integrations": [ { "url": "https://api.buddy.works/user/integrations/R7ZGebEDoa07Zr8yWldgVjL4pv", "html_url": "https://app.buddy.works/toprus/-/workspace/integrations/R7ZGebEDoa07Zr8yWldgVjL4pv", "identifier": "github", "hash_id": "R7ZGebEDoa07Zr8yWldgVjL4pv", "name": "GitHub", "type": "GIT_HUB", "auth_type": "APP_RW", "scope": "WORKSPACE", "permissions": { "others": "USE_ONLY", "users": [ { "id": 1, "access_level": "MANAGE" } ], "admins": "MANAGE" }, "all_pipelines_allowed": true, "allowed_pipelines": [] }, { "url": "https://api.buddy.works/user/integrations/NLVaDzgp6W2qJljaQlJOoYdmZ3", "html_url": "https://app.buddy.works/toprus/-/workspace/integrations/NLVaDzgp6W2qJljaQlJOoYdmZ3", "identifier": "amazon-web-services", "hash_id": "NLVaDzgp6W2qJljaQlJOoYdmZ3", "name": "Amazon Web Services", "type": "AMAZON", "auth_type": "DEFAULT", "scope": "PROJECT", "project_name": "asdf", "permissions": { "others": "USE_ONLY", "users": [ { "id": 1, "access_level": "MANAGE" } ], "admins": "MANAGE" }, "all_pipelines_allowed": true, "allowed_pipelines": [] } ] } } } } }, "security": [ { "oauth2": [ "INTEGRATION_INFO" ] } ] }, "post": { "tags": [ "Workspace API" ], "summary": "Add a new integration to the workspace", "operationId": "addIntegration", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddIntegrationRequest" }, "examples": { "GitHub Integration": { "description": "GitHub Integration", "value": { "type": "GIT_HUB", "identifier": "my-github-integration", "name": "GitHub Integration", "token": "ghp_xxxxxxxxxxxxxxxxxxxx", "scope": "PROJECT", "project_name": "my-project", "all_pipelines_allowed": true } }, "GitHub with Username": { "description": "GitHub with Username", "value": { "identifier": "my_identifier", "name": "my_name", "type": "GIT_HUB", "scope": "WORKSPACE", "username": "Buddy", "token": "12bd78f43e3dcad41afd13f69429a00a0c8a18dcf2" } }, "GitLab Integration": { "description": "GitLab Integration", "value": { "type": "GIT_LAB", "identifier": "my-gitlab-integration", "name": "GitLab Integration", "token": "glpat-xxxxxxxxxxxxxxxxxxxx", "scope": "WORKSPACE", "all_pipelines_allowed": true } }, "AWS with Access Keys": { "description": "AWS with Access Keys", "value": { "type": "AMAZON", "identifier": "aws-token-integration", "name": "Amazon Web Services (Token)", "access_key_id": "AKIAIOSFODNN7EXAMPLE", "secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "scope": "PROJECT", "project_name": "my-project", "all_pipelines_allowed": true } }, "AWS with Role Assumptions": { "description": "AWS with Role Assumptions", "value": { "name": "Buddy AWS integration", "type": "AMAZON", "scope": "PROJECT", "project_name": "company-website", "access_key": "AKIAVASPKE3ZWWV7V5BI", "secret_key": "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", "identifier": "my_aws_integration", "role_assumptions": [ { "arn": "arn:aws:iam::123457465779:role/TESTS", "external_id": "ext_id", "duration": 9000 } ], "all_pipelines_allowed": false, "permissions": { "admins": "MANAGE", "others": "DENIED", "users": [ { "id": 1, "access_level": "USE_ONLY" } ], "groups": [ { "id": 1, "access_level": "USE_ONLY" } ] }, "allowed_pipelines": [ { "id": 1 } ] } }, "AWS OIDC": { "description": "AWS OIDC", "value": { "name": "Buddy (OIDC)", "type": "AMAZON", "scope": "WORKSPACE", "role_assumptions": [ { "arn": "arn:aws:iam::344897465719:role/my-oidc-role", "duration": 1234 } ], "auth_type": "OIDC", "audience": "tests" } }, "Microsoft Azure": { "description": "Microsoft Azure", "value": { "type": "AZURE", "identifier": "azure-integration", "name": "Microsoft Azure", "tenant_id": "12345678-1234-1234-1234-123456789012", "subscription_id": "87654321-4321-4321-4321-210987654321", "app_id": "app-id-example", "password": "app-password-example", "scope": "WORKSPACE", "all_pipelines_allowed": true } }, "Docker Hub": { "description": "Docker Hub", "value": { "type": "DOCKER_HUB", "identifier": "dockerhub-integration", "name": "Docker Hub", "username": "my-docker-user", "password": "docker-hub-token-or-password", "scope": "PROJECT", "project_name": "my-project", "all_pipelines_allowed": false, "allowed_pipelines": [ { "id": 123 }, { "id": 456 } ] } }, "DigitalOcean": { "description": "DigitalOcean", "value": { "identifier": "my_digital_ocean", "name": "digitalocean", "type": "DIGITAL_OCEAN", "scope": "WORKSPACE", "token": "dop_v1_e5b1c199475559a23a4c148f5ef7264f4456ceed6fa2a9e19b506ab34ba83740" } }, "Google Service Account": { "description": "Google Service Account", "value": { "identifier": "qljfpaaipt", "name": "slskopytko", "type": "GOOGLE_SERVICE_ACCOUNT", "scope": "WORKSPACE", "api_key": "{\n \"type\": \"service_account\",\n \"project_id\": \"buddy\",\n \"private_key_id\": \"97c7fbe597f688c45eb5e4ef0bf7cd6f68959cad\",\n \"private_key\": \"-----BEGIN PRIVATE KEY-----\\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDweDgPi1cbAabJ\\n/ZT9b3uIUF7CyuZSg2/l6VMy3AcQXw90XNKv6OAq9WEhgmHdTS6eUCCRR5G4HiiY\\nw02pImtl1wWWqt7qBrgZgcvUcQ0CAh0/qUCuGCPFQ/XPbLJ2J/WQRcoEM3PsoEIn\\ndP7uJf22Cm5tCJCElrlQ8OmwzGzS5+O8eXG1AhWAqWVnOVZgpfhnhAxB00XGXZpR\\nvrvTKfKPNjvMQDMBM9yU8xZ4LYO8r3CftfSC+HQRiZXCPw4cjZ6/Ebq7TNFfwjuB\\nDrvgkitbNWYW8CzNRiGDplT+I6h8ea8uE8D4dWocPAC4M3sHb2JPExarzXNnFLmq\\n7JBr7j03AgMBAAECggEAd/y0lGUFsK8RR0al2hOPg0P/FJljdZap9gGHhyAs0ils\\nr7ZFVosPl7/amHrTVDZX5Zy7s2IPvtwli5wgGx3WkvlIi5Z1Jjb2E5wlVbqXMAJY\\nD9TnNjdLWfoAJGDrZ5Om3zdDhvcZh9+rQr7pGXGReA0aboNQgSgoDdA4GvQV9OHS\\nrWDyvcY6xWCy80iJE9jYjK5rPuaFUciJyAOoCXi80pMbmNrabjoTFv0hMDslesyC\\nP5TpppSsswr0ag8m400YakyzFJyzBFIteGX7hUcumNgsP1gevikdnspSX3uNjGFK\\nnwBcV49Hg9He3KjP7wP3mLxz58px56q7gWAtv46CAQKBgQD6p/Iy4BfBKGJ9hUC1\\npTLQ53he9BFB9xqALdLyOyK8UWeJupo6XOAUlqKnd0PJsjkdcoYyJomIlJEk6Jd3\\nUOZmiv5upkqtXtGCby20wkJPK4Lm80RC0akdvRUVjfudAgFNjuWlIPn4gfQ+p/sW\\nyf66G9l87mfWBm9vzn6v9XFENwKBgQD1mK0qcMv7Xn03p8MwCbJDvcYNATZqTEzW\\nGzRZeRV3HSO8PQvJXWun212zmBgw8M7rdLbgn0lDN3S/AIjOyg5qycOFgtYRrU6O\\nmn+iTQTnM2jmbjQwpAl0+gJKSDlKcZAKALs1AtDiLQHKE1qvAOss22MGI6Zv6qA8\\n32oSORBPAQKBgQDOTDnP25ZReN6O9oRKvDt1qnzska4+f5UFGDH9AeTV3536wmU7\\nUcNvzobyk/tr3s6ZSO/gCM27ZqOLIA/BuQjYLt+iZfcid96xnrWchyGyLVqgoGl3\\nIT4yZrQauG/1SnguEEU7wkdaXALdKr5ChF+tZ0x6QXGeuk8vU2H7imP9wwKBgD8N\\nAD/qD2QsQOdd6W1Wv+5GNSc3jXnCtuMsvsbNoCYhVABKh9Eda7r/RVILFQLTf7vR\\nDfYizpM0FIPIpla4ZvUhcVHAYibNoGjZ5bSMI1sbxq2J01o9crQWTyo02ohzGTCI\\nOYeFfoziUxhG2bwd90Jf3E9CLcODr7mQ/dFJ1xcBAoGAMi5qGvMgpi5cjdAZ4pC+\\n3TIJ5ZXjoTBtC9tKwPWw7tREQK9I4VtWDicJ6psfYhGfg4vYbuW80TJ5NLukyp3O\\npylWCauLck/BPS2Q3SSyQ4Fi8fc2upsMqV0Ta3X1XEMBL8+Q5G1kuSwxN4xC+U0u\\n9gKF73devYKj9xkrSEnDF4E=\\n-----END PRIVATE KEY-----\\n\",\n \"client_email\": \"buddy@buddy.iam.gserviceaccount.com\",\n \"client_id\": \"105237793416275966994\",\n \"auth_uri\": \"https://accounts.google.com/o/oauth2/auth\",\n \"token_uri\": \"https://oauth2.googleapis.com/token\",\n \"auth_provider_x509_cert_url\": \"https://www.googleapis.com/oauth2/v1/certs\",\n \"client_x509_cert_url\": \"https://www.googleapis.com/robot/v1/metadata/x509/buddy%40buddy.iam.gserviceaccount.com\"\n}\n", "auth_type": "DEFAULT" } }, "New Relic": { "description": "New Relic", "value": { "name": "buddy", "type": "NEW_RELIC", "scope": "WORKSPACE", "token": "NRAK-F9LDREIBQN0NUI56NJYRB1DHR3Z", "region": "US" } } } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationView" }, "example": { "url": "https://api.buddy.works/workspaces/my-company/user/integrations/abc123def456", "html_url": "https://app.buddy.works/my-company/integrations/NLVaDzgp6W2qJljaQlJOoYdmZ3", "hash_id": "NLVaDzgp6W2qJljaQlJOoYdmZ3", "name": "GitHub Integration", "type": "GIT_HUB", "identifier": "my-github-integration", "scope": "WORKSPACE", "auth_type": "TOKEN", "webhook_address": "https://api.github.com/repos/username/repository/hooks", "all_pipelines_allowed": true, "allowed_pipelines": [], "permissions": { "others": "USE_ONLY", "admins": "MANAGE", "users": [], "groups": [] } } } } } }, "security": [ { "oauth2": [ "INTEGRATION_ADD" ] } ] } }, "/workspaces/{workspace_domain}/integrations/{hash_id}": { "get": { "tags": [ "Workspace API" ], "summary": "Get a specific integration by hash ID", "operationId": "getIntegration", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "hash_id", "in": "path", "description": "The hash ID of the integration", "required": true, "schema": { "type": "string", "example": "abc123def456" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationView" }, "example": { "url": "https://api.buddy.works/workspaces/my-company/user/integrations/abc123def456", "html_url": "https://app.buddy.works/my-company/integrations/NLVaDzgp6W2qJljaQlJOoYdmZ3", "hash_id": "NLVaDzgp6W2qJljaQlJOoYdmZ3", "name": "GitHub Integration", "type": "GIT_HUB", "identifier": "my-github-integration", "scope": "WORKSPACE", "auth_type": "TOKEN", "webhook_address": "https://api.github.com/repos/username/repository/hooks", "all_pipelines_allowed": true, "allowed_pipelines": [], "permissions": { "others": "USE_ONLY", "admins": "MANAGE", "users": [], "groups": [] } } } } } }, "security": [ { "oauth2": [ "INTEGRATION_INFO" ] } ] }, "delete": { "tags": [ "Workspace API" ], "summary": "Delete an integration", "operationId": "deleteIntegration", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "hash_id", "in": "path", "description": "The hash ID of the integration", "required": true, "schema": { "type": "string", "example": "abc123def456" } } ], "responses": { "204": { "description": "Integration deleted successfully" } }, "security": [ { "oauth2": [ "INTEGRATION_MANAGE" ] } ] }, "patch": { "tags": [ "Workspace API" ], "summary": "Update integration configuration", "operationId": "updateIntegration", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "hash_id", "in": "path", "description": "The hash ID of the integration", "required": true, "schema": { "type": "string", "example": "abc123def456" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateIntegrationRequest" }, "example": { "identifier": "GitHub", "name": "Updated GitHub Integration", "token": "ghp_yyyyyyyyyyyyyyyyyyyy", "all_pipelines_allowed": false, "allowed_pipelines": [ { "id": 123 }, { "id": 456 } ], "disabled": true } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationView" }, "example": { "url": "https://api.buddy.works/workspaces/my-company/user/integrations/abc123def456", "html_url": "https://app.buddy.works/my-company/integrations/NLVaDzgp6W2qJljaQlJOoYdmZ3", "hash_id": "NLVaDzgp6W2qJljaQlJOoYdmZ3", "name": "GitHub Integration", "type": "GIT_HUB", "identifier": "my-github-integration", "scope": "WORKSPACE", "auth_type": "TOKEN", "webhook_address": "https://api.github.com/repos/username/repository/hooks", "all_pipelines_allowed": true, "allowed_pipelines": [], "permissions": { "others": "USE_ONLY", "admins": "MANAGE", "users": [], "groups": [] } } } } } }, "security": [ { "oauth2": [ "INTEGRATION_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/members": { "get": { "tags": [ "Workspace API" ], "summary": "Get all members in the workspace", "operationId": "getWorkspaceMembers", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "page", "in": "query", "description": "The number of the successive pages (results are split into pages of per_page elements each).", "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "per_page", "in": "query", "description": "Specifies the number of returned elements on the page. The default value is 20.", "schema": { "type": "integer", "format": "int32", "example": 20 } }, { "name": "sort_by", "in": "query", "description": "Specifies ordering for workspace members. Can be one of `id` or `name`.", "schema": { "type": "string", "example": "name" } }, { "name": "sort_direction", "in": "query", "description": "Specifies the direction of the ordering. Can be one of `ASC` or `DESC`", "schema": { "type": "string", "example": "ASC" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceMembersView" }, "example": { "url": "https://api.buddy.works/workspaces/my-company/members", "html_url": "https://app.buddy.works/my-company/-/people", "members": [ { "url": "https://api.buddy.works/workspaces/my-company/members/216", "html_url": "https://app.buddy.works/my-company/-/profile/216", "id": 2, "name": "Leon", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/2/1/6/0216e0eaead35ceec361a9eb6fc165ab/w/32/32/AVATAR.png", "email": "leon@example.com", "admin": false, "workspace_owner": false, "auto_assign_permission_set_id": 2 }, { "url": "https://api.buddy.works/workspaces/my-company/members/1", "html_url": "https://app.buddy.works/my-company/-/profile/1", "id": 1, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png", "email": "john@example.com", "admin": true, "workspace_owner": true, "auto_assign_permission_set_id": 1 } ] } } } } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] }, "post": { "tags": [ "Workspace API" ], "summary": "Add a new member to the workspace", "operationId": "addWorkspaceMember", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddWorkspaceMemberRequest" }, "example": { "email": "user@example.com", "admin": false, "auto_assign_to_new_projects": true, "auto_assign_permission_set_id": 1 } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceMemberView" }, "example": { "url": "https://api.buddy.works/workspaces/my-company/members/1", "html_url": "https://app.buddy.works/my-company/-/profile/1", "id": 1, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png", "email": "john@example.com", "admin": true, "workspace_owner": true, "auto_assign_to_new_projects": true, "auto_assign_permission_set_id": 1 } } } } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] } }, "/workspaces/{workspace_domain}/members/{id}": { "get": { "tags": [ "Workspace API" ], "summary": "Get a specific workspace member by ID", "operationId": "getWorkspaceMember", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "id", "in": "path", "description": "The ID of the member", "required": true, "schema": { "type": "integer", "format": "int32", "example": 216 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceMemberView" }, "example": { "url": "https://api.buddy.works/workspaces/my-company/members/1", "html_url": "https://app.buddy.works/my-company/-/profile/1", "id": 1, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png", "email": "john@example.com", "admin": true, "workspace_owner": true, "auto_assign_to_new_projects": true, "auto_assign_permission_set_id": 1 } } } } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] }, "delete": { "tags": [ "Workspace API" ], "summary": "Remove a member from the workspace", "operationId": "deleteWorkspaceMember", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "id", "in": "path", "description": "The ID of the member", "required": true, "schema": { "type": "integer", "format": "int32", "example": 216 } } ], "responses": { "204": { "description": "Workspace member deleted successfully" } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] }, "patch": { "tags": [ "Workspace API" ], "summary": "Update workspace member configuration", "operationId": "updateWorkspaceMember", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "id", "in": "path", "description": "The ID of the member", "required": true, "schema": { "type": "integer", "format": "int32", "example": 216 } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWorkspaceMemberRequest" }, "example": { "admin": true, "auto_assign_to_new_projects": false, "auto_assign_permission_set_id": 2 } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceMemberView" }, "example": { "url": "https://api.buddy.works/workspaces/my-company/members/1", "html_url": "https://app.buddy.works/my-company/-/profile/1", "id": 1, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png", "email": "john@example.com", "admin": true, "workspace_owner": true, "auto_assign_to_new_projects": true, "auto_assign_permission_set_id": 1 } } } } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] } }, "/workspaces/{workspace_domain}/members/{user_id}/projects": { "get": { "tags": [ "Workspace API" ], "summary": "Get all projects accessible to a workspace member", "operationId": "getWorkspaceMemberProjects", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "user_id", "in": "path", "description": "The ID of the user", "required": true, "schema": { "type": "integer", "format": "int32", "example": 456 } }, { "name": "page", "in": "query", "description": "The number of the successive pages (results are split into pages of per_page elements each).", "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "per_page", "in": "query", "description": "Specifies the number of returned elements on the page. The default value is 20.", "schema": { "type": "integer", "format": "int32", "example": 20 } }, { "name": "status", "in": "query", "description": "Filters projects by the specified status. Can be one of `ACTIVE` or `CLOSED`", "schema": { "type": "string", "example": "ACTIVE" } }, { "name": "sort_by", "in": "query", "description": "Specifies ordering. Can be one of `name`, `create_date` or `repository_size`", "schema": { "type": "string", "example": "name" } }, { "name": "sort_direction", "in": "query", "description": "Specifies the direction of the ordering. Can be one of `ASC` or `DESC`", "schema": { "type": "string", "example": "ASC" } }, { "name": "all", "in": "query", "description": "If set to true, returns all projects accessible to the user", "schema": { "type": "string", "example": "true" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectsView" }, "example": { "url": "https://api.buddy.works/workspaces/my-company/members/456/projects", "html_url": "https://app.buddy.works/my-company", "projects": [ { "url": "https://api.buddy.works/workspaces/my-company/projects/landing-page", "html_url": "https://app.buddy.works/my-company/landing-page", "name": "landing-page", "display_name": "Landing Page", "status": "ACTIVE", "create_date": "2023-01-15T10:30:00Z" }, { "url": "https://api.buddy.works/workspaces/my-company/projects/api-backend", "html_url": "https://app.buddy.works/my-company/api-backend", "name": "api-backend", "display_name": "API Backend Service", "status": "ACTIVE", "create_date": "2023-02-20T14:45:30Z" } ] } } } } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] } }, "/workspaces/{workspace_domain}/permissions": { "get": { "tags": [ "Permission API" ], "summary": "Get details of custom permission sets in a workspace", "operationId": "getPermissionSets", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "Workspace domain", "required": true, "schema": { "type": "string", "example": "my-company" } } ], "responses": { "200": { "description": "Permission sets retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermissionSetsView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/permissions", "html_url": "https://app.buddy.works/my-workspace/-/permissions", "permission_sets": [ { "url": "https://api.buddy.works/workspaces/my-workspace/permissions/1", "html_url": "https://app.buddy.works/my-workspace/-/permissions/edit/1", "id": 1, "name": "Developer", "type": "DEVELOPER", "repository_access_level": "READ_WRITE", "pipeline_access_level": "READ_WRITE", "sandbox_access_level": "READ_WRITE", "project_team_access_level": "READ_ONLY", "environment_access_level": "MANAGE", "artifact_access_level": "MANAGE" }, { "url": "https://api.buddy.works/workspaces/my-workspace/permissions/2", "html_url": "https://app.buddy.works/my-workspace/-/permissions/edit/2", "id": 2, "name": "Viewer", "type": "READ_ONLY", "repository_access_level": "READ_ONLY", "pipeline_access_level": "READ_ONLY", "sandbox_access_level": "READ_ONLY", "project_team_access_level": "READ_ONLY", "environment_access_level": "USE_ONLY", "artifact_access_level": "READ_ONLY" }, { "url": "https://api.buddy.works/workspaces/my-workspace/permissions/3", "html_url": "https://app.buddy.works/my-workspace/-/permissions/edit/3", "id": 3, "name": "Project Manager", "type": "PROJECT_MANAGER", "repository_access_level": "MANAGE", "pipeline_access_level": "READ_WRITE", "sandbox_access_level": "READ_WRITE", "project_team_access_level": "MANAGE", "environment_access_level": "MANAGE", "artifact_access_level": "MANAGE" } ] } } } } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] }, "post": { "tags": [ "Permission API" ], "summary": "Creates a custom permission set. Restricted to admins only.", "operationId": "addPermissionSet", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "Workspace domain", "required": true, "schema": { "type": "string", "example": "my-company" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddPermissionSetRequest" }, "example": { "name": "Developer", "description": "Full development access with restrictions", "repository_access_level": "READ_WRITE", "pipeline_access_level": "READ_WRITE", "sandbox_access_level": "READ_WRITE", "project_team_access_level": "READ_ONLY", "environment_access_level": "USE_ONLY", "artifact_access_level": "READ_WRITE" } } } }, "responses": { "201": { "description": "Permission set created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermissionSetView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/permissions/4", "html_url": "https://app.buddy.works/my-workspace/-/permissions/edit/4", "id": 4, "name": "Artist", "description": "Artists can only view source", "type": "CUSTOM", "repository_access_level": "READ_ONLY", "pipeline_access_level": "DENIED", "sandbox_access_level": "DENIED", "project_team_access_level": "READ_ONLY", "environment_access_level": "DENIED", "artifact_access_level": "DENIED" } } } } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] } }, "/workspaces/{workspace_domain}/permissions/{id}": { "get": { "tags": [ "Permission API" ], "summary": "Get details of single custom permission set", "operationId": "getPermissionSet", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "Workspace domain", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "id", "in": "path", "description": "The ID of the permission set", "required": true, "schema": { "type": "integer", "format": "int32", "example": 4 } } ], "responses": { "200": { "description": "Permission set details retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermissionSetView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/permissions/1", "html_url": "https://app.buddy.works/my-workspace/-/permissions/edit/1", "id": 1, "name": "Developer", "type": "DEVELOPER", "repository_access_level": "READ_WRITE", "pipeline_access_level": "READ_WRITE", "sandbox_access_level": "READ_WRITE", "project_team_access_level": "READ_ONLY", "environment_access_level": "MANAGE", "artifact_access_level": "MANAGE" } } } } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] }, "delete": { "tags": [ "Permission API" ], "summary": "Deletes a custom permission set. Restricted to admins only.", "operationId": "deletePermissionSet", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "Workspace domain", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "id", "in": "path", "description": "The ID of the permission set", "required": true, "schema": { "type": "integer", "format": "int32", "example": 4 } } ], "responses": { "204": { "description": "Permission set deleted successfully" } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] }, "patch": { "tags": [ "Permission API" ], "summary": "Edits a custom permission set. Restricted to admins only.", "operationId": "updatePermissionSet", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "Workspace domain", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "id", "in": "path", "description": "The ID of the permission set", "required": true, "schema": { "type": "integer", "format": "int32", "example": 4 } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePermissionSetRequest" }, "example": { "name": "Updated Artist", "description": "Updated artists permissions", "repository_access_level": "READ_WRITE", "pipeline_access_level": "READ_ONLY", "sandbox_access_level": "READ_ONLY", "project_team_access_level": "READ_ONLY", "environment_access_level": "DENIED", "artifact_access_level": "DENIED" } } } }, "responses": { "200": { "description": "Permission set updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermissionSetView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/permissions/4", "html_url": "https://app.buddy.works/my-workspace/-/permissions/edit/4", "id": 4, "name": "Updated Artist", "description": "Updated artists permissions", "type": "CUSTOM", "repository_access_level": "READ_WRITE", "pipeline_access_level": "READ_ONLY", "sandbox_access_level": "READ_ONLY", "project_team_access_level": "READ_ONLY", "environment_access_level": "DENIED", "artifact_access_level": "DENIED" } } } } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] } }, "/workspaces/{workspace_domain}/projects": { "get": { "tags": [ "Project API" ], "summary": "Get all projects in the workspace", "operationId": "getProjects", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "page", "in": "query", "description": "The number of the successive pages (results are split into pages of per_page elements each).", "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "per_page", "in": "query", "description": "Specifies the number of returned elements on the page. The default value is 20.", "schema": { "type": "integer", "format": "int32", "example": 20 } }, { "name": "status", "in": "query", "description": "Filters projects by the specified status. Can be one of `ACTIVE` or `CLOSED`", "schema": { "type": "string", "example": "ACTIVE" } }, { "name": "sort_by", "in": "query", "description": "Specifies ordering. Can be one of `name`, `create_date` or `repository_size`", "schema": { "type": "string", "example": "name" } }, { "name": "sort_direction", "in": "query", "description": "Specifies the direction of the ordering. Can be one of `ASC` or `DESC`", "schema": { "type": "string", "example": "ASC" } }, { "name": "membership", "in": "query", "description": "Filter projects by membership. If set to true, administrators get only the projects to which they belong in the workspace.", "schema": { "type": "string", "example": "true" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectsView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects", "html_url": "https://app.buddy.works/my-workspace", "projects": [ { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project", "html_url": "https://app.buddy.works/my-workspace/projects/my-project", "name": "my-project", "display_name": "My Project", "status": "ACTIVE", "access": "PRIVATE", "create_date": "2023-01-15T10:30:00Z" }, { "url": "https://api.buddy.works/workspaces/my-workspace/projects/api-backend", "html_url": "https://app.buddy.works/my-workspace/projects/api-backend", "name": "api-backend", "display_name": "API Backend Service", "status": "ACTIVE", "access": "PRIVATE", "create_date": "2023-02-20T14:45:30Z" } ] } } } } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] }, "post": { "tags": [ "Project API" ], "summary": "Create a new project", "operationId": "addProject", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CreateBuddyProjectRequest" }, { "$ref": "#/components/schemas/CreateIntegratedProjectRequest" }, { "$ref": "#/components/schemas/CreateCustomRepoProjectRequest" } ] }, "examples": { "Create new Buddy project": { "description": "Create new Buddy project", "value": { "name": "landing-page", "display_name": "Landing page", "access": "PUBLIC", "fetch_submodules": true, "fetch_submodules_env_key": "id_workspace", "allow_pull_requests": true } }, "Create integrated project (GitHub/GitLab/Bitbucket)": { "description": "Create integrated project (GitHub/GitLab/Bitbucket)", "value": { "name": "landing-page", "display_name": "Landing page", "external_project_id": "buddy/landing-page", "integration": { "hash_id": "5ddb7c180fb38be67bd78a88a" }, "access": "PUBLIC", "fetch_submodules": true, "fetch_submodules_env_key": "id_workspace", "allow_pull_requests": true, "update_default_branch_from_external": true } }, "Create custom repository project": { "description": "Create custom repository project", "value": { "name": "custom-repo-project", "display_name": "Custom Repository Project", "custom_repo_url": "https://github.com/company/private-repo.git", "custom_repo_user": "deployment-user", "custom_repo_pass": "access-token", "access": "PRIVATE", "fetch_submodules": false } } } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project", "html_url": "https://app.buddy.works/my-workspace/projects/my-project", "name": "my-project", "display_name": "My Project", "external_project_id": null, "gitlab_project_id": null, "custom_repo_url": null, "custom_repo_user": null, "custom_repo_pass": null, "custom_repo_ssh_key_id": null, "status": "ACTIVE", "access": "PRIVATE", "create_date": "2023-01-15T10:30:00Z", "created_by": { "url": "https://api.buddy.works/workspaces/my-workspace/members/123", "html_url": "https://app.buddy.works/my-workspace/profile/123", "id": 123, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/123/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6/w/32/32/AVATAR.png?ts=1674644200000", "email": "john.doe@company.com", "admin": false, "workspace_owner": false }, "http_repository": "https://git.buddy.works/my-workspace/my-project.git", "ssh_repository": "git@git.buddy.works:my-workspace/my-project.git", "default_branch": "main", "integration": null, "fetch_submodules": true, "fetch_submodules_env_key": "id_workspace", "allow_pull_requests": true, "update_default_branch_from_external": false, "without_repository": false } } } } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}": { "get": { "tags": [ "Project API" ], "summary": "Get a specific project by name", "operationId": "getProject", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project", "html_url": "https://app.buddy.works/my-workspace/projects/my-project", "name": "my-project", "display_name": "My Project", "external_project_id": null, "gitlab_project_id": null, "custom_repo_url": null, "custom_repo_user": null, "custom_repo_pass": null, "custom_repo_ssh_key_id": null, "status": "ACTIVE", "access": "PRIVATE", "create_date": "2023-01-15T10:30:00Z", "created_by": { "url": "https://api.buddy.works/workspaces/my-workspace/members/123", "html_url": "https://app.buddy.works/my-workspace/profile/123", "id": 123, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/123/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6/w/32/32/AVATAR.png?ts=1674644200000", "email": "john.doe@company.com", "admin": false, "workspace_owner": false }, "http_repository": "https://git.buddy.works/my-workspace/my-project.git", "ssh_repository": "git@git.buddy.works:my-workspace/my-project.git", "default_branch": "main", "integration": null, "fetch_submodules": true, "fetch_submodules_env_key": "id_workspace", "allow_pull_requests": true, "update_default_branch_from_external": false, "without_repository": false } } } } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] }, "delete": { "tags": [ "Project API" ], "summary": "Delete a project", "operationId": "deleteProject", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } } ], "responses": { "204": { "description": "Project deleted successfully" } }, "security": [ { "oauth2": [ "PROJECT_DELETE" ] } ] }, "patch": { "tags": [ "Project API" ], "summary": "Update project configuration", "operationId": "updateProject", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProjectRequest" }, "examples": { "Update project configuration": { "description": "Update project configuration", "value": { "name": "updated-landing-page", "display_name": "Updated Landing Page", "status": "ACTIVE", "access": "PUBLIC", "fetch_submodules": false, "fetch_submodules_env_key": "updated_key", "allow_pull_requests": false, "update_default_branch_from_external": true } }, "Update project name only": { "description": "Update project name only", "value": { "display_name": "My Renamed Project" } } } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project", "html_url": "https://app.buddy.works/my-workspace/projects/my-project", "name": "my-project", "display_name": "My Project", "external_project_id": null, "gitlab_project_id": null, "custom_repo_url": null, "custom_repo_user": null, "custom_repo_pass": null, "custom_repo_ssh_key_id": null, "status": "ACTIVE", "access": "PRIVATE", "create_date": "2023-01-15T10:30:00Z", "created_by": { "url": "https://api.buddy.works/workspaces/my-workspace/members/123", "html_url": "https://app.buddy.works/my-workspace/profile/123", "id": 123, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/123/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6/w/32/32/AVATAR.png?ts=1674644200000", "email": "john.doe@company.com", "admin": false, "workspace_owner": false }, "http_repository": "https://git.buddy.works/my-workspace/my-project.git", "ssh_repository": "git@git.buddy.works:my-workspace/my-project.git", "default_branch": "main", "integration": null, "fetch_submodules": true, "fetch_submodules_env_key": "id_workspace", "allow_pull_requests": true, "update_default_branch_from_external": false, "without_repository": false } } } } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/crawl/suites": { "get": { "tags": [ "Crawl API" ], "summary": "Get all crawl suites for a project", "operationId": "getSuites", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CrawlSuitesView" } } } } }, "security": [ { "oauth2": [ "CRAWL_INFO" ] } ] }, "post": { "tags": [ "Crawl API" ], "summary": "Add a new crawl suite to a project", "operationId": "addSuite", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddCrawlSuiteRequestView" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CrawlSuiteView" } } } } }, "security": [ { "oauth2": [ "CRAWL_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/crawl/suites/{suite_id}": { "get": { "tags": [ "Crawl API" ], "summary": "Get a crawl suite", "operationId": "getSuite", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "suite_id", "in": "path", "description": "The ID of the crawl suite", "required": true, "schema": { "type": "string", "example": "MNbyVedg" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CrawlSuiteView" } } } } }, "security": [ { "oauth2": [ "CRAWL_INFO" ] } ] }, "delete": { "tags": [ "Crawl API" ], "summary": "Delete a crawl suite", "operationId": "deleteSuite", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "suite_id", "in": "path", "description": "The ID of the crawl suite", "required": true, "schema": { "type": "string", "example": "MNbyVedg" } } ], "responses": { "204": { "description": "Crawl suite deleted successfully" } }, "security": [ { "oauth2": [ "CRAWL_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/crawl/suites/{suite_id}/sessions": { "get": { "tags": [ "Crawl API" ], "summary": "Get crawl sessions for a suite", "operationId": "getSessions", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "suite_id", "in": "path", "description": "The ID of the crawl suite", "required": true, "schema": { "type": "string", "example": "MNbyVedg" } }, { "name": "from", "in": "query", "description": "The offset for pagination (0-based)", "schema": { "type": "integer", "format": "int32", "example": 0 } }, { "name": "limit", "in": "query", "description": "The maximum number of sessions to return", "schema": { "type": "integer", "format": "int32", "example": 20 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CrawlSessionsView" } } } } }, "security": [ { "oauth2": [ "CRAWL_INFO" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/crawl/suites/{suite_id}/sessions/{session_id}": { "get": { "tags": [ "Crawl API" ], "summary": "Get a crawl session", "operationId": "getSession", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "suite_id", "in": "path", "description": "The ID of the crawl suite", "required": true, "schema": { "type": "string", "example": "MNbyVedg" } }, { "name": "session_id", "in": "path", "description": "The ID of the crawl session", "required": true, "schema": { "type": "string", "example": "MNbyVedg" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CrawlSessionView" } } } } }, "security": [ { "oauth2": [ "CRAWL_INFO" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/crawl/suites/{suite_id}/token": { "get": { "tags": [ "Crawl API" ], "summary": "Get crawl suite token", "operationId": "getToken", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "suite_id", "in": "path", "description": "The ID of the crawl suite", "required": true, "schema": { "type": "string", "example": "MNbyVedg" } } ], "responses": { "default": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/String" } } } } }, "security": [ { "oauth2": [ "CRAWL_INFO" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/groups": { "get": { "tags": [ "Project API" ], "summary": "Lists all groups assigned to the specified project. The authorized user must have admin rights in the project to get the information about permissions in that project", "operationId": "getProjectGroups", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectGroupsView" }, "example": { "url": "https://api.buddy.works/workspaces/my-company/projects/my-project/groups", "html_url": "https://app.buddy.works/my-company/my-project/team", "groups": [ { "url": "https://api.buddy.works/workspaces/my-company/projects/my-project/groups/4", "html_url": "https://app.buddy.works/my-company/-/groups/4", "id": 4, "name": "Frontend Team", "permission_set": { "url": "https://api.buddy.works/workspaces/my-company/permissions/1", "html_url": "https://app.buddy.works/my-company/-/permissions/edit/1", "name": "Developer", "repository_access_level": "READ_WRITE", "pipeline_access_level": "READ_WRITE", "sandbox_access_level": "READ_WRITE", "project_team_access_level": "READ_ONLY", "environment_access_level": "MANAGE", "artifact_access_level": "MANAGE", "id": 1, "type": "DEVELOPER" } }, { "url": "https://api.buddy.works/workspaces/my-company/projects/my-project/groups/5", "html_url": "https://app.buddy.works/my-company/-/groups/5", "id": 5, "name": "Backend Team", "permission_set": { "url": "https://api.buddy.works/workspaces/my-company/permissions/2", "html_url": "https://app.buddy.works/my-company/-/permissions/edit/2", "name": "Senior Developer", "repository_access_level": "READ_WRITE", "pipeline_access_level": "READ_WRITE", "sandbox_access_level": "READ_WRITE", "project_team_access_level": "MANAGE", "environment_access_level": "MANAGE", "artifact_access_level": "MANAGE", "id": 2, "type": "CUSTOM" } } ] } } } } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] }, "post": { "tags": [ "Project API" ], "summary": "Assign a group to the project", "operationId": "addProjectGroup", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddProjectGroupRequest" }, "example": { "id": 4, "permission_set": { "id": 1 } } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectGroupView" }, "example": { "url": "https://api.buddy.works/workspaces/my-company/projects/my-project/groups/4", "html_url": "https://app.buddy.works/my-company/-/groups/4", "id": 4, "name": "Frontend Team", "permission_set": { "url": "https://api.buddy.works/workspaces/my-company/permissions/1", "html_url": "https://app.buddy.works/my-company/-/permissions/edit/1", "name": "Developer", "repository_access_level": "READ_WRITE", "pipeline_access_level": "READ_WRITE", "sandbox_access_level": "READ_WRITE", "project_team_access_level": "READ_ONLY", "environment_access_level": "MANAGE", "artifact_access_level": "MANAGE", "id": 1, "type": "DEVELOPER" } } } } } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/groups/{id}": { "get": { "tags": [ "Project API" ], "summary": "Returns a single user group in the specified project", "operationId": "getProjectGroup", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "id", "in": "path", "description": "The ID of the group", "required": true, "schema": { "type": "integer", "format": "int32", "example": 123 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectGroupView" }, "example": { "url": "https://api.buddy.works/workspaces/my-company/projects/my-project/groups/4", "html_url": "https://app.buddy.works/my-company/-/groups/4", "id": 4, "name": "Frontend Team", "permission_set": { "url": "https://api.buddy.works/workspaces/my-company/permissions/1", "html_url": "https://app.buddy.works/my-company/-/permissions/edit/1", "name": "Developer", "repository_access_level": "READ_WRITE", "pipeline_access_level": "READ_WRITE", "sandbox_access_level": "READ_WRITE", "project_team_access_level": "READ_ONLY", "environment_access_level": "MANAGE", "artifact_access_level": "MANAGE", "id": 1, "type": "DEVELOPER" } } } } } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] }, "delete": { "tags": [ "Project API" ], "summary": "Remove a group from the project", "operationId": "deleteProjectGroup", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "id", "in": "path", "description": "The ID of the group", "required": true, "schema": { "type": "integer", "format": "int32", "example": 123 } } ], "responses": { "204": { "description": "Project group deleted successfully" } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] }, "patch": { "tags": [ "Project API" ], "summary": "Update project group permissions", "operationId": "updateProjectGroup", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "id", "in": "path", "description": "The ID of the group", "required": true, "schema": { "type": "integer", "format": "int32", "example": 123 } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProjectGroupRequest" }, "example": { "permission_set": { "id": 2 } } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectGroupView" }, "example": { "url": "https://api.buddy.works/workspaces/my-company/projects/my-project/groups/4", "html_url": "https://app.buddy.works/my-company/-/groups/4", "id": 4, "name": "Frontend Team", "permission_set": { "url": "https://api.buddy.works/workspaces/my-company/permissions/1", "html_url": "https://app.buddy.works/my-company/-/permissions/edit/1", "name": "Developer", "repository_access_level": "READ_WRITE", "pipeline_access_level": "READ_WRITE", "sandbox_access_level": "READ_WRITE", "project_team_access_level": "READ_ONLY", "environment_access_level": "MANAGE", "artifact_access_level": "MANAGE", "id": 1, "type": "DEVELOPER" } } } } } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/members": { "get": { "tags": [ "Project API" ], "summary": "Get all members in the project", "operationId": "getProjectMembers", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "page", "in": "query", "description": "The number of the successive pages (results are split into pages of per_page elements each).", "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "per_page", "in": "query", "description": "Specifies the number of returned elements on the page. The default value is 20.", "schema": { "type": "integer", "format": "int32", "example": 20 } }, { "name": "sort_by", "in": "query", "description": "Specifies ordering for workspace members. Can be one of `id` or `name`.", "schema": { "type": "string", "example": "name" } }, { "name": "sort_direction", "in": "query", "description": "Specifies the direction of the ordering. Can be one of `ASC` or `DESC`", "schema": { "type": "string", "example": "ASC" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectMembersView" }, "example": { "url": "https://api.buddy.works/workspaces/my-company/project/53/members", "html_url": "https://app.buddy.works/my-company/my-project/team", "members": [ { "url": "https://api.buddy.works/workspaces/my-company/project/53/members/216", "html_url": "https://app.buddy.works/my-company/-/profile/216", "id": 216, "name": "Leon", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/2/1/6/0216e0eaead35ceec361a9eb6fc165ab/w/32/32/AVATAR.png", "email": "leon@example.com", "admin": false, "workspace_owner": false }, { "url": "https://api.buddy.works/workspaces/my-company/project/53/members/215", "html_url": "https://app.buddy.works/my-company/-/profile/215", "id": 215, "name": "Admin", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1757917622833", "email": "admin@example.com", "admin": true, "workspace_owner": true } ] } } } } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] }, "post": { "tags": [ "Project API" ], "summary": "Add a new member to the project", "operationId": "addProjectMember", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddProjectMemberRequest" }, "example": { "id": 216, "permission_set": { "id": 1 } } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectMemberView" }, "example": { "url": "https://api.buddy.works/workspaces/my-company/projects/my-project/members/216", "html_url": "https://app.buddy.works/my-company/-/profile/216", "id": 216, "name": "Leon", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/2/1/6/0216e0eaead35ceec361a9eb6fc165ab/w/32/32/AVATAR.png", "email": "leon@example.com", "admin": false, "workspace_owner": false, "permission_set": { "url": "https://api.buddy.works/workspaces/toprus/permissions/1", "html_url": "https://app.buddy.works/my-company/-/permissions/edit/1", "name": "Developer", "repository_access_level": "READ_WRITE", "pipeline_access_level": "READ_WRITE", "sandbox_access_level": "READ_WRITE", "project_team_access_level": "READ_ONLY", "environment_access_level": "MANAGE", "artifact_access_level": "MANAGE", "id": 1, "type": "DEVELOPER" } } } } } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/members/{id}": { "get": { "tags": [ "Project API" ], "summary": "Get a specific project member by ID", "operationId": "getProjectMember", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "id", "in": "path", "description": "The ID of the member", "required": true, "schema": { "type": "integer", "format": "int32", "example": 216 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectMemberView" }, "example": { "url": "https://api.buddy.works/workspaces/my-company/projects/my-project/members/216", "html_url": "https://app.buddy.works/my-company/-/profile/216", "id": 216, "name": "Leon", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/2/1/6/0216e0eaead35ceec361a9eb6fc165ab/w/32/32/AVATAR.png", "email": "leon@example.com", "admin": false, "workspace_owner": false, "permission_set": { "url": "https://api.buddy.works/workspaces/toprus/permissions/1", "html_url": "https://app.buddy.works/my-company/-/permissions/edit/1", "name": "Developer", "repository_access_level": "READ_WRITE", "pipeline_access_level": "READ_WRITE", "sandbox_access_level": "READ_WRITE", "project_team_access_level": "READ_ONLY", "environment_access_level": "MANAGE", "artifact_access_level": "MANAGE", "id": 1, "type": "DEVELOPER" } } } } } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] }, "delete": { "tags": [ "Project API" ], "summary": "Remove a member from the project", "operationId": "deleteProjectMember", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "id", "in": "path", "description": "The ID of the member", "required": true, "schema": { "type": "integer", "format": "int32", "example": 216 } } ], "responses": { "204": { "description": "Project member deleted successfully" } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] }, "patch": { "tags": [ "Project API" ], "summary": "Update project member permissions", "operationId": "updateProjectMember", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "id", "in": "path", "description": "The ID of the member", "required": true, "schema": { "type": "integer", "format": "int32", "example": 216 } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProjectMemberRequest" }, "example": { "permission_set": { "id": 2 } } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectMemberView" }, "example": { "url": "https://api.buddy.works/workspaces/my-company/projects/my-project/members/216", "html_url": "https://app.buddy.works/my-company/-/profile/216", "id": 216, "name": "Leon", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/2/1/6/0216e0eaead35ceec361a9eb6fc165ab/w/32/32/AVATAR.png", "email": "leon@example.com", "admin": false, "workspace_owner": false, "permission_set": { "url": "https://api.buddy.works/workspaces/toprus/permissions/1", "html_url": "https://app.buddy.works/my-company/-/permissions/edit/1", "name": "Developer", "repository_access_level": "READ_WRITE", "pipeline_access_level": "READ_WRITE", "sandbox_access_level": "READ_WRITE", "project_team_access_level": "READ_ONLY", "environment_access_level": "MANAGE", "artifact_access_level": "MANAGE", "id": 1, "type": "DEVELOPER" } } } } } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/pipelines": { "get": { "tags": [ "Project API" ], "summary": "Returns all pipelines from the specified project. Pipelines hidden using visibility settings are not included", "operationId": "getPipelines", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "page", "in": "query", "description": "The number of the successive pages (results are split into pages of per_page elements each).", "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "per_page", "in": "query", "description": "Specifies the number of returned elements on the page. The default value is 20.", "schema": { "type": "integer", "format": "int32", "example": 20 } }, { "name": "sort_by", "in": "query", "description": "Specifies the column to sort results by. Can be one of `name` or `id`", "schema": { "type": "string", "example": "name" } }, { "name": "sort_direction", "in": "query", "description": "Specifies the direction of the ordering. Can be one of `ASC` or `DESC`", "schema": { "type": "string", "example": "ASC" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/PipelinesView" }, { "$ref": "#/components/schemas/PipelinesYamlView" } ] }, "examples": { "List of pipelines (JSON format)": { "description": "List of pipelines (JSON format)", "value": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/pipelines", "html_url": "https://app.buddy.works/my-workspace/my-project/pipelines", "pipelines": [ { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/pipelines/123", "html_url": "https://app.buddy.works/my-workspace/my-project/pipelines/pipeline/123", "id": 123, "identifier": "deploy-production", "name": "Deploy to production", "definition_source": "LOCAL", "git_config_ref": "NONE", "refs": [ "refs/heads/main" ], "events": [ { "type": "WEBHOOK" } ], "priority": "NORMAL", "disabled": false, "last_execution_status": "INITIAL", "always_from_scratch": false, "ignore_fail_on_project_status": false, "strict_context": false, "no_skip_to_most_recent": false, "terminate_stale_runs": false, "auto_clear_cache": false, "fetch_all_refs": false, "fetch_lfs": false, "fail_on_prepare_env_warning": true, "concurrent_pipeline_runs": false, "do_not_create_commit_status": false, "stale": false, "waiting_for_push": false, "resources": "DEFAULT", "git_changeset_base": "LATEST_RUN", "filesystem_changeset_base": "DATE_MODIFIED", "cpu": "X64", "description_required": false } ] } }, "Pipelines exported as YAML": { "description": "Pipelines exported as YAML", "value": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/pipelines", "html_url": "https://app.buddy.works/my-workspace/my-project/pipelines", "yaml": "LSBwaXBlbGluZTogZGVwbG95LXByb2R1Y3Rpb24KICByZWZzOgogIC0gcmVmcy9oZWFkcy9tYWluCiAgcHJpb3JpdHk6IEhJR0gKICBmYWlsX29uX3ByZXBhcmVfZW52X3dhcm5pbmc6IHRydWUKICBhY3Rpb25zOgogIC0gYWN0aW9uOiBEZXBsb3kgdG8gcHJvZHVjdGlvbgogICAgdHlwZTogQlVJTEQKICAgIGRvY2tlcl9pbWFnZV9uYW1lOiBidWRkeS9sb2NhbHNoZWxsCiAgICBkb2NrZXJfaW1hZ2VfdGFnOiB1YnVudHVfMjQuMDQKICAgIGV4ZWN1dGVfY29tbWFuZHM6CiAgICAtIGVjaG8gIkRlcGxveWluZy4uLiIKICAgIHNoZWxsOiBCQVNICi0gcGlwZWxpbmU6IHRlc3Qtc3VpdGUKICByZWZzOgogIC0gcmVmcy9oZWFkcy9tYXN0ZXIKICBldmVudHM6CiAgLSB0eXBlOiBXRUJIT09LCiAgZmFpbF9vbl9wcmVwYXJlX2Vudl93YXJuaW5nOiB0cnVlCiAgcmVzb3VyY2VzOiBTTUFMTAogIGFjdGlvbnM6CiAgLSBhY3Rpb246IFJ1b" } } } } } } }, "security": [ { "oauth2": [ "EXECUTION_INFO" ] } ] }, "post": { "tags": [ "Project API" ], "summary": "Creates a new pipeline in the project", "operationId": "addPipeline", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ClonePipelineRequest" }, { "$ref": "#/components/schemas/AddPipelineRequest" } ] }, "examples": { "Clone existing pipeline": { "description": "Clone existing pipeline", "value": { "source_pipeline_id": 123, "name": "Cloned Pipeline", "identifier": "cloned-pipeline" } }, "Create minimal pipeline": { "description": "Create minimal pipeline", "value": { "name": "Deploy to production", "trigger_condition": "ALWAYS" } }, "Create pipeline with full configuration": { "description": "Create pipeline with full configuration", "value": { "name": "Tests", "identifier": "test", "refs": [ "refs/heads/main" ], "events": [ { "type": "PUSH", "refs": [ ":context", "refs/heads/dev-*" ] }, { "type": "CREATE_REF", "refs": [ "refs/heads/feature-*" ] }, { "type": "DELETE_REF", "refs": [ "refs/heads/temp-*" ] }, { "type": "PULL_REQUEST", "events": [ "assigned", "unassigned" ], "branches": [ "main", "releases/*" ] }, { "type": "SCHEDULE", "start_date": "2025-01-01T08:00:00.000Z", "delay": 60, "refs": [ "refs/heads/development" ] }, { "type": "WEBHOOK", "totp": true }, { "type": "PUBLISH_ARTIFACT_VERSION", "artifacts": [ { "identifier": "my-artifact", "scope": "PROJECT" }, { "identifier": "shared-artifact", "scope": "WORKSPACE" } ] }, { "type": "CREATE_ARTIFACT_VERSION", "artifacts": [ { "identifier": "new-artifact:*", "scope": "PROJECT" } ] }, { "type": "DELETE_ARTIFACT_VERSION", "artifacts": [ { "identifier": "deprecated-artifact", "scope": "ANY" } ] }, { "type": "EMAIL", "prefix": "deploy", "whitelist": [ "admin@company.com", "deploy@company.com" ] }, { "type": "SANDBOX_CREATED", "targets": [ { "type": "MATCH", "filter": { "identifier": "my-sandbox-*", "scope": "ANY" } } ] }, { "type": "SANDBOX_DELETED", "targets": [ { "type": "MATCH", "filter": { "identifier": "*", "scope": "ANY" } } ] }, { "type": "SANDBOX_TIMED_OUT", "targets": [ { "type": "MATCH", "filter": { "identifier": "staging-*", "scope": "ANY", "tags": [ "production" ] } } ] } ], "folder": "CI/CD", "priority": "HIGH", "disabled": false, "disabled_reason": null, "target_site_url": "https://example.com", "execution_message_template": "test", "always_from_scratch": true, "ignore_fail_on_project_status": true, "no_skip_to_most_recent": true, "terminate_stale_runs": false, "cache_scope": "WORKSPACE", "auto_clear_cache": true, "pause_on_repeated_failures": 3, "fetch_all_refs": false, "fetch_lfs": false, "fail_on_prepare_env_warning": true, "concurrent_pipeline_runs": true, "clone_depth": 5, "do_not_create_commit_status": true, "trigger_conditions": [ { "trigger_condition": "ON_CHANGE_AT_PATH", "trigger_condition_paths": [ "src/**/*", "tests/**/*" ] }, { "trigger_condition": "VAR_IS", "trigger_variable_key": "ENV", "trigger_variable_value": "production" }, { "trigger_condition": "VAR_GREATER_THAN", "trigger_variable_key": "BUILD_NUMBER", "trigger_variable_value": "100" }, { "trigger_condition": "DATETIME", "trigger_days": [ 1, 2, 3, 4, 5 ], "trigger_hours": [ 9, 10, 11, 14, 15, 16 ], "timezone": "Europe/Warsaw" }, { "trigger_condition": "SUCCESS_PIPELINE", "trigger_project_name": "my-project", "trigger_pipeline_name": "build" }, { "trigger_condition": "TRIGGERING_USER_IS", "trigger_user": "admin@company.com" }, { "trigger_condition": "TRIGGERING_USER_IS_IN_GROUP", "trigger_group": "DevOps Team" }, { "trigger_condition": "OR", "trigger_operands": [ { "trigger_condition": "VAR_IS", "trigger_variable_key": "DEPLOY", "trigger_variable_value": "true" }, { "trigger_condition": "TRIGGERING_USER_IS", "trigger_user": "release-manager@company.com" } ] } ], "variables": [ { "key": "my_var", "value": "some_value" } ], "resources": "LARGE", "git_changeset_base": "LATEST_RUN_MATCHING_REF", "filesystem_changeset_base": "CONTENTS", "tags": [ "backend", "testing" ], "cpu": "ARM", "description_required": false, "manage_variables_by_yaml": false, "manage_permissions_by_yaml": false, "environments": [ { "type": "STAGE", "identifier": "my_stage_env", "tags": [ "myTag" ] } ], "artifacts": [ { "identifier": "my-artifact", "scope": "PROJECT" }, { "identifier": "shared-lib", "scope": "WORKSPACE" } ], "permissions": { "others": "DENIED", "users": [ { "id": 1, "access_level": "READ_WRITE" } ], "groups": [ { "id": 320, "access_level": "READ_ONLY" } ] }, "paused": false } } } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineResponse" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/pipelines/620", "html_url": "https://app.buddy.works/my-workspace/my-project/pipelines/pipeline/620", "id": 620, "identifier": "test", "name": "Tests", "definition_source": "LOCAL", "git_config_ref": "NONE", "refs": [ "refs/heads/main" ], "events": [ { "type": "PUSH", "refs": [ ":context", "refs/heads/dev-*" ] }, { "type": "CREATE_REF", "refs": [ "refs/heads/feature-*" ] }, { "type": "DELETE_REF", "refs": [ "refs/heads/temp-*" ] }, { "type": "PULL_REQUEST", "events": [ "assigned", "unassigned" ], "branches": [ "main", "releases/*" ] }, { "type": "SCHEDULE", "refs": [ "refs/heads/development" ], "start_date": "2025-01-01T08:00:00Z", "delay": 60 }, { "type": "WEBHOOK", "totp": true }, { "type": "PUBLISH_ARTIFACT_VERSION", "artifacts": [ { "identifier": "my-artifact", "scope": "PROJECT" }, { "identifier": "shared-artifact", "scope": "WORKSPACE" } ] }, { "type": "CREATE_ARTIFACT_VERSION", "artifacts": [ { "identifier": "new-artifact:*", "scope": "PROJECT" } ] }, { "type": "DELETE_ARTIFACT_VERSION", "artifacts": [ { "identifier": "deprecated-artifact", "scope": "ANY" } ] }, { "type": "EMAIL", "prefix": "deploy", "whitelist": [ "admin@company.com", "deploy@company.com" ] }, { "type": "SANDBOX_CREATED", "targets": [ { "type": "MATCH", "filter": { "identifier": "my-sandbox-*", "scope": "ANY" } } ] }, { "type": "SANDBOX_DELETED", "targets": [ { "type": "MATCH", "filter": { "identifier": "*", "scope": "ANY" } } ] }, { "type": "SANDBOX_TIMED_OUT", "targets": [ { "type": "MATCH", "filter": { "identifier": "staging-*", "scope": "ANY", "tags": [ "production" ] } } ] } ], "folder": "CI/CD", "priority": "HIGH", "disabled": false, "disabled_reason": null, "last_execution_status": "INITIAL", "target_site_url": "https://example.com", "execution_message_template": "test", "create_date": "2025-10-02T07:20:53Z", "always_from_scratch": true, "ignore_fail_on_project_status": true, "strict_context": false, "no_skip_to_most_recent": true, "terminate_stale_runs": false, "auto_clear_cache": true, "paused": false, "pause_on_repeated_failures": 3, "fetch_all_refs": false, "fetch_lfs": false, "fail_on_prepare_env_warning": true, "concurrent_pipeline_runs": true, "clone_depth": 5, "do_not_create_commit_status": true, "stale": false, "waiting_for_push": false, "trigger_conditions": [ { "trigger_condition": "ON_CHANGE_AT_PATH", "trigger_condition_paths": [ "src/**/*", "tests/**/*" ] }, { "trigger_condition": "VAR_IS", "trigger_variable_key": "ENV", "trigger_variable_value": "production" }, { "trigger_condition": "VAR_GREATER_THAN", "trigger_variable_key": "BUILD_NUMBER", "trigger_variable_value": "100" }, { "trigger_condition": "DATETIME", "trigger_days": [ 1, 2, 3, 4, 5 ], "trigger_hours": [ 9, 10, 11, 14, 15, 16 ], "timezone": "Europe/Warsaw" }, { "trigger_condition": "SUCCESS_PIPELINE", "trigger_project_name": "my-project", "trigger_pipeline_name": "build" }, { "trigger_condition": "TRIGGERING_USER_IS", "trigger_user": "admin@company.com" }, { "trigger_condition": "TRIGGERING_USER_IS_IN_GROUP", "trigger_group": "DevOps Team" }, { "trigger_condition": "OR", "trigger_operands": [ { "trigger_condition": "VAR_IS", "trigger_variable_key": "DEPLOY", "trigger_variable_value": "true" }, { "trigger_condition": "TRIGGERING_USER_IS", "trigger_user": "release-manager@company.com" } ] } ], "resources": "LARGE", "git_changeset_base": "LATEST_RUN_MATCHING_REF", "filesystem_changeset_base": "CONTENTS", "tags": [ "backend", "testing" ], "cpu": "ARM", "description_required": false, "project": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project", "html_url": "https://app.buddy.works/my-workspace/my-project", "name": "my-project", "display_name": "My Project", "status": "ACTIVE" }, "creator": { "url": "https://api.buddy.works/workspaces/my-workspace/members/123", "html_url": "https://app.buddy.works/my-workspace/-/profile/123", "id": 123, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/123/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6/w/32/32/AVATAR.png?ts=1674644200000", "email": "john.doe@company.com", "admin": true, "workspace_owner": true }, "cache_scope": "PIPELINE", "variables": [ { "id": 1514, "key": "my_var", "value": "some_value", "type": "VAR", "description": "" } ], "environments": [ { "identifier": "my_stage_env", "tags": [ "myTag" ], "scope": "ANY" } ], "artifacts": [ { "identifier": "my-artifact", "scope": "PROJECT" }, { "identifier": "shared-lib", "scope": "WORKSPACE" } ], "permissions": { "others": "DENIED", "users": [ { "id": 1, "access_level": "READ_WRITE" } ], "groups": [ { "id": 320, "access_level": "READ_ONLY" } ] }, "manage_variables_by_yaml": false, "manage_permissions_by_yaml": false, "actions": [] } } } } }, "security": [ { "oauth2": [ "EXECUTION_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/pipelines/{id}": { "get": { "tags": [ "Project API" ], "summary": "Returns details of a single pipeline", "operationId": "getPipeline", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "id", "in": "path", "description": "The ID of the pipeline", "required": true, "schema": { "type": "integer", "format": "int32", "example": 123 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineResponse" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/pipelines/123", "html_url": "https://app.buddy.works/my-workspace/my-project/pipelines/pipeline/123", "id": 123, "identifier": "deploy-production", "name": "Deploy to production", "definition_source": "LOCAL", "git_config_ref": "NONE", "refs": [ "refs/heads/main" ], "events": [ { "type": "PUSH" } ], "priority": "NORMAL", "disabled": false, "last_execution_status": "SUCCESSFUL", "create_date": "2023-01-15T10:30:00Z", "always_from_scratch": false, "ignore_fail_on_project_status": false, "strict_context": false, "no_skip_to_most_recent": false, "terminate_stale_runs": false, "auto_clear_cache": false, "fetch_all_refs": false, "fetch_lfs": false, "fail_on_prepare_env_warning": true, "concurrent_pipeline_runs": false, "do_not_create_commit_status": false, "stale": false, "waiting_for_push": false, "resources": "DEFAULT", "git_changeset_base": "LATEST_RUN", "filesystem_changeset_base": "DATE_MODIFIED", "cpu": "X64", "description_required": false, "project": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project", "html_url": "https://app.buddy.works/my-workspace/projects/my-project", "name": "my-project", "display_name": "My Project", "status": "ACTIVE" }, "creator": { "url": "https://api.buddy.works/workspaces/my-workspace/members/123", "html_url": "https://app.buddy.works/my-workspace/-/profile/123", "id": 123, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/123/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6/w/32/32/AVATAR.png?ts=1674644200000", "email": "john.doe@company.com", "admin": true, "workspace_owner": false }, "cache_scope": "PIPELINE", "variables": [], "environments": [], "permissions": { "others": "DEFAULT" }, "manage_variables_by_yaml": false, "manage_permissions_by_yaml": false, "actions": [ { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/pipelines/123/actions/456", "html_url": "https://app.buddy.works/my-workspace/my-project/pipelines/pipeline/123/action/456/edit", "id": 456, "name": "Build application", "type": "BUILD", "trigger_time": "ON_EVERY_EXECUTION", "last_execution_status": "SUCCESSFUL", "current_revision": "abc123def456", "disabled": false, "ignore_errors": false, "run_next": "WAIT_ON_SUCCESS" } ] } } } } }, "security": [ { "oauth2": [ "EXECUTION_INFO" ] } ] }, "delete": { "tags": [ "Project API" ], "summary": "Delete a pipeline", "operationId": "deletePipeline", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "id", "in": "path", "description": "The ID of the pipeline", "required": true, "schema": { "type": "integer", "format": "int32", "example": 123 } } ], "responses": { "204": { "description": "Pipeline deleted successfully" } }, "security": [ { "oauth2": [ "EXECUTION_MANAGE" ] } ] }, "patch": { "tags": [ "Project API" ], "summary": "Update pipeline configuration", "operationId": "updatePipeline", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "id", "in": "path", "description": "The ID of the pipeline", "required": true, "schema": { "type": "integer", "format": "int32", "example": 123 } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UpdatePipelineRequest" }, { "$ref": "#/components/schemas/ClearCacheRequest" } ] }, "examples": { "Update pipeline configuration": { "description": "Update pipeline configuration", "value": { "name": "Updated Pipeline Name", "priority": "NORMAL", "disabled": false, "always_from_scratch": true, "no_skip_to_most_recent": false, "fetch_all_refs": true, "fetch_lfs": false, "clone_depth": 5 } }, "Update pipeline name only": { "description": "Update pipeline name only", "value": { "name": "New Pipeline Name" } }, "Clear pipeline cache": { "description": "Clear pipeline cache", "value": { "clear_cache": true } } } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineResponse" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/pipelines/123", "html_url": "https://app.buddy.works/my-workspace/my-project/pipelines/pipeline/123", "id": 123, "identifier": "deploy-production", "name": "Deploy to production", "definition_source": "LOCAL", "git_config_ref": "NONE", "refs": [ "refs/heads/main" ], "events": [ { "type": "PUSH" } ], "priority": "NORMAL", "disabled": false, "last_execution_status": "SUCCESSFUL", "create_date": "2023-01-15T10:30:00Z", "always_from_scratch": false, "ignore_fail_on_project_status": false, "strict_context": false, "no_skip_to_most_recent": false, "terminate_stale_runs": false, "auto_clear_cache": false, "fetch_all_refs": false, "fetch_lfs": false, "fail_on_prepare_env_warning": true, "concurrent_pipeline_runs": false, "do_not_create_commit_status": false, "stale": false, "waiting_for_push": false, "resources": "DEFAULT", "git_changeset_base": "LATEST_RUN", "filesystem_changeset_base": "DATE_MODIFIED", "cpu": "X64", "description_required": false, "project": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project", "html_url": "https://app.buddy.works/my-workspace/projects/my-project", "name": "my-project", "display_name": "My Project", "status": "ACTIVE" }, "creator": { "url": "https://api.buddy.works/workspaces/my-workspace/members/123", "html_url": "https://app.buddy.works/my-workspace/-/profile/123", "id": 123, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/123/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6/w/32/32/AVATAR.png?ts=1674644200000", "email": "john.doe@company.com", "admin": true, "workspace_owner": false }, "cache_scope": "PIPELINE", "variables": [], "environments": [], "permissions": { "others": "DEFAULT" }, "manage_variables_by_yaml": false, "manage_permissions_by_yaml": false, "actions": [ { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/pipelines/123/actions/456", "html_url": "https://app.buddy.works/my-workspace/my-project/pipelines/pipeline/123/action/456/edit", "id": 456, "name": "Build application", "type": "BUILD", "trigger_time": "ON_EVERY_EXECUTION", "last_execution_status": "SUCCESSFUL", "current_revision": "abc123def456", "disabled": false, "ignore_errors": false, "run_next": "WAIT_ON_SUCCESS" } ] } } } } }, "security": [ { "oauth2": [ "EXECUTION_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/pipelines/{pipeline_id}/actions": { "get": { "tags": [ "Action API" ], "summary": "Returns list of actions in the specified pipeline", "operationId": "getActions", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "pipeline_id", "in": "path", "description": "The ID of the pipeline", "required": true, "schema": { "type": "integer", "format": "int32", "example": 123 } }, { "name": "trigger_time", "in": "query", "description": "Filter actions by trigger time", "schema": { "type": "string", "example": "ON_EVERY_EXECUTION", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionsView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/pipelines/791/actions", "html_url": "https://app.buddy.works/my-workspace/my-project/pipelines/pipeline/791/manage", "actions": [ { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/pipelines/791/actions/1233", "html_url": "https://app.buddy.works/my-workspace/my-project/pipelines/pipeline/791/action/1233/edit", "id": 1233, "name": "mvn artifact", "type": "BUILD", "current_revision": "58e239079a2161fec0ba96ed166557157ad3dd79", "trigger_time": "ON_EVERY_EXECUTION", "run_next": "WAIT_ON_SUCCESS", "disabled": false, "ignore_errors": false, "last_execution_status": "SUCCESSFUL" }, { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/pipelines/791/actions/1234", "html_url": "https://app.buddy.works/my-workspace/my-project/pipelines/pipeline/791/action/1234/edit", "id": 1234, "name": "Transfer files", "type": "TRANSFER", "current_revision": "58e239079a2161fec0ba96ed166557157ad3dd79", "trigger_time": "ON_EVERY_EXECUTION", "run_next": "WAIT_ON_SUCCESS", "disabled": false, "ignore_errors": false, "last_execution_status": "SUCCESSFUL" }, { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/pipelines/791/actions/1235", "html_url": "https://app.buddy.works/my-workspace/my-project/pipelines/pipeline/791/action/1235/edit", "id": 1235, "name": "Send notification to Telegram Channel", "type": "TELEGRAM", "current_revision": "", "trigger_time": "ON_EVERY_EXECUTION", "run_next": "WAIT_ON_SUCCESS", "disabled": false, "ignore_errors": false, "integration": { "identifier": "telegram" }, "last_execution_status": "INPROGRESS" } ] } } } } }, "security": [ { "oauth2": [ "EXECUTION_INFO" ] } ] }, "post": { "tags": [ "Action API" ], "summary": "Creates a new action in the pipeline", "operationId": "addAction", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "pipeline_id", "in": "path", "description": "The ID of the pipeline", "required": true, "schema": { "type": "integer", "format": "int32", "example": 123 } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionRequest" }, "examples": { "Build (BUILD)": { "description": "Build (BUILD)", "value": { "name": "Build Android app", "type": "BUILD", "trigger_time": "ON_EVERY_EXECUTION", "docker_image_name": "library/openjdk", "docker_image_tag": "8", "volume_mappings": [ "/:/buddy/mount/directory" ], "execute_commands": [ "export ANDROID_HOME=/opt/android/sdk", "chmod +x gradlew", "./gradlew assembleRelease" ], "setup_commands": [ "mkdir -p /opt/android/sdk && mkdir .android", "cd /opt/android/sdk && curl -o sdk.zip https://dl.google.com/android/repository/sdk-tools-linux-3859397.zip && unzip sdk.zip && rm sdk.zip", "yes | /opt/android/sdk/tools/bin/sdkmanager --licenses", "/opt/android/sdk/tools/bin/sdkmanager --update", "/opt/android/sdk/tools/bin/sdkmanager platform-tools", "/opt/android/sdk/tools/bin/sdkmanager tools", "/opt/android/sdk/tools/bin/sdkmanager emulator", "/opt/android/sdk/tools/bin/sdkmanager \"extras;android;m2repository\"", "/opt/android/sdk/tools/bin/sdkmanager \"extras;google;m2repository\"", "/opt/android/sdk/tools/bin/sdkmanager \"extras;google;google_play_services\"", "/opt/android/sdk/tools/bin/sdkmanager \"build-tools;27.0.3\"", "/opt/android/sdk/tools/bin/sdkmanager \"platforms;android-27\"" ], "working_directory": "/buddy/my-repo-dir" } }, "Email notification (EMAIL)": { "description": "Email notification (EMAIL)", "value": { "name": "EMAIL Action", "type": "EMAIL", "trigger_time": "ON_EVERY_EXECUTION", "variables": [ { "key": "emailTitle", "value": "Pipeline executed successfully!" } ], "file_attachments": [ "fs:///file1", "fs:///file2" ], "content": "${BUDDY_PIPELINE_NAME} execution #${BUDDY_RUN_ID}", "recipients": "admin@mailinator.com\r\nmanage@mailinator.com", "title": "$emailTitle", "from_name": "Buddy", "send_as_html": true, "send_to_groups": [ "Managers", "Developers" ] } }, "Amazon S3 (AMAZON_S3)": { "description": "Amazon S3 (AMAZON_S3)", "value": { "name": "Upload files to Amazon S3", "type": "AMAZON_S3", "input_type": "SCM_REPOSITORY", "trigger_time": "ON_EVERY_EXECUTION", "local_path": "/assets/", "remote_path": "Home/www/", "bucket_name": "buddy-tests", "acl": "PUBLIC_READ_WRITE", "skip_content_type_setting": false, "reduced_redundancy": true, "expires_date": "2017-01-07T00:00:00.000Z", "cache_control": "max-age=3600", "deploy_tags": [ { "key": "revision", "value": "$BUDDY_RUN_COMMIT" }, { "key": "buddy_last_modification_type", "value": "$BUDDY_EXECUTION_FILE_MODIFICATION_TYPE" } ], "deletion_disabled": true, "deployment_excludes": [ "/tmp/", "*.log" ], "deployment_includes": [ "/assets/style", "/tmp/file.txt" ], "integration": { "identifier": "aws-s3" } } }, "SSH Command (SSH_COMMAND)": { "description": "SSH Command (SSH_COMMAND)", "value": { "name": "Execute commands on 192.0.2.1", "type": "SSH_COMMAND", "trigger_time": "ON_EVERY_EXECUTION", "working_directory": "tests/SSH_Tests/", "commands": [ "date >> tmp.log" ], "targets": [ { "type": "SSH", "identifier": "vlatncuatc", "host": "192.0.2.1", "port": "22", "auth": { "method": "PASSWORD", "username": "buddy", "password": "$MyPassword" } } ], "run_as_script": true, "shell": "BASH", "execute_every_command": false } }, "HTTP Request (HTTP)": { "description": "HTTP Request (HTTP)", "value": { "name": "HTTP Action", "type": "HTTP", "trigger_time": "ON_EVERY_EXECUTION", "variables": [ { "key": "endpointUrl", "value": "http://mywebserver.io" } ], "content": "Pipeline executed successfully!", "notification_url": "$endpointUrl", "port": "1234", "method": "PATCH", "timeout": 120, "headers": [ { "name": "User-Agent", "value": "Buddy" } ] } }, "Visual tests (VISUAL_TESTS)": { "description": "Visual tests (VISUAL_TESTS)", "value": { "name": "Visual Tests", "type": "VISUAL_TESTS", "trigger_time": "ON_EVERY_EXECUTION", "headers": [ { "name": "header1", "value": "value1" }, { "name": "header2", "value": "value2" } ], "resolution_width": 1920, "resolution_height": 1080, "pixel_tolerance_level": 1.23, "images_history_limit": 30, "screenshots": [ { "url": "https://buddy.works/", "baseline": "https://buddy.works/", "headers": [ { "name": "header1", "value": "value1" }, { "name": "header2", "value": "value2" } ], "excluded_areas": [ { "min_x": 200, "min_y": 100, "max_x": 500, "max_y": 200 } ] } ], "permissions": { "others": "DENIED", "users": [ { "id": 1, "access_level": "ALLOWED" } ], "groups": [ { "id": 1, "access_level": "ALLOWED" } ] } } }, "Visual Test 2.0 (VISUAL_TEST_2)": { "description": "Visual Test 2.0 (VISUAL_TEST_2)", "value": { "name": "Visual Test 2.0", "type": "VISUAL_TEST_2", "trigger_time": "ON_EVERY_EXECUTION", "vt_suite": "my_first_suite", "urls": [ "https://example.com", "https://buddy.works" ], "sitemap": "https://buddy.works/sitemap.xml", "urls_file": "pages.txt", "ignore_urls": [ "https://example.com/*" ], "follow": true, "respect_robots": true, "ignores": [ "CSS=.ad-banner" ], "delays": [ "1000" ], "wait_for": [ "CSS=#content" ], "cookies": [ "session=abc123" ], "headers": [ "Authorization=Bearer token" ] } }, "Slack notification (SLACK)": { "description": "Slack notification (SLACK)", "value": { "name": "SLACK Action", "type": "SLACK", "trigger_time": "ON_EVERY_EXECUTION", "content": "Pipeline Execution successful!", "channel": "C024BE91L", "attachments": [ "{\"fallback\":\"${BUDDY_PIPELINE_NAME} execution\",\"color\":\"${color}\",\"fields\":[{\"title\":\"Status\",\"value\":\"Success\"}]}" ], "variables": [ { "key": "color", "value": "good" } ], "file_attachments": [ "fs:///file1", "fs:///file2" ], "integration": { "identifier": "slack" } } }, "Telegram notification (TELEGRAM)": { "description": "Telegram notification (TELEGRAM)", "value": { "name": "Telegram notification", "type": "TELEGRAM", "trigger_time": "ON_EVERY_EXECUTION", "content": "[#$BUDDY_RUN_ID] $BUDDY_PIPELINE_NAME execution by [$BUDDY_INVOKER_NAME]($BUDDY_INVOKER_URL)", "file_attachments": [ "fs:///file1", "fs:///file2" ], "integration": { "identifier": "telegram" } } }, "Discord notification (DISCORD2)": { "description": "Discord notification (DISCORD2)", "value": { "name": "Discord notification", "disabled": true, "type": "DISCORD2", "trigger_time": "ON_EVERY_EXECUTION", "content": "[#BUDDY_EXECUTION_ID] BUDDY_PIPELINE_NAME by BUDDY_INVOKER_NAME", "notification_url": "https://discordapp.com/api/webhooks/453797939572375553/zi3NxdcB6yFW66UN8kece3mT92-u1BpaBUc2CYWoBMrrIJpK7t5lBr5nxFUqc9v9eKX8", "attachments": [ "{\"name\":\"Revision\"}" ], "file_attachments": [ "fs:///fghajxwgad" ], "variables": [ { "key": "env_key", "value": "env_value", "type": "VAR", "settable": false, "run_only_settable": false, "encrypted": false, "description": "kyaawfeucm" } ], "timeout": 1800, "retry_interval": 60, "retry_count": 5, "ignore_errors": true, "current_revision": "21825f31ddce8a89b3ed9f4c92f038b339cde150", "loop": [ "env_key" ] } }, "Microsoft Teams (MICROSOFT_TEAMS)": { "description": "Microsoft Teams (MICROSOFT_TEAMS)", "value": { "name": "Send Microsoft Teams notification", "type": "MICROSOFT_TEAMS", "trigger_time": "ON_EVERY_EXECUTION", "content": "[#$BUDDY_RUN_ID] $BUDDY_PIPELINE_NAME execution by [$BUDDY_INVOKER_NAME]($BUDDY_INVOKER_URL)", "recipients": "example@example.com", "title": "$title", "send_as_html": true, "file_attachments": [ "attachment" ] } }, "Google Chat (GOOGLE_CHAT)": { "description": "Google Chat (GOOGLE_CHAT)", "value": { "name": "Send notification to Google Chat", "type": "GOOGLE_CHAT", "trigger_time": "ON_EVERY_EXECUTION", "content": "Pipeline Execution successful!", "channel": "spaces/AAAA99999", "integration": { "identifier": "google-chat" } } }, "Sms notification (SMS)": { "description": "Sms notification (SMS)", "value": { "name": "SMS Action", "type": "SMS", "trigger_time": "ON_EVERY_EXECUTION", "content": "Pipeline executed successfully!", "recipients": "11234567890\n12345678901" } }, "Pushover (PUSHOVER)": { "description": "Pushover (PUSHOVER)", "value": { "name": "Send notification to My-Chrome", "type": "PUSHOVER", "title": "$title", "trigger_time": "ON_EVERY_EXECUTION", "variables": [ { "key": "title", "value": "Notification title" } ], "content": "${BUDDY_PIPELINE_NAME} execution #${BUDDY_RUN_ID}", "link": "${BUDDY_RUN_URL}", "link_title": "Show execution details", "device": "My-Chrome", "priority": "HIGH", "integration": { "identifier": "pushover" } } }, "Pushbullet (PUSHBULLET)": { "description": "Pushbullet (PUSHBULLET)", "value": { "name": "Send notification to My-Chrome", "type": "PUSHBULLET", "title": "$title", "trigger_time": "ON_EVERY_EXECUTION", "variables": [ { "key": "title", "value": "Notification title" } ], "content": "${BUDDY_PIPELINE_NAME} execution #${BUDDY_RUN_ID}", "link": "${BUDDY_RUN_URL}", "device": "uju3yZ7gq6usjAiVsKnSTs", "integration": { "identifier": "pushbullet" } } }, "Honeybadger (HONEYBADGER)": { "description": "Honeybadger (HONEYBADGER)", "value": { "name": "Honeybadger notification", "type": "HONEYBADGER", "trigger_time": "ON_EVERY_EXECUTION", "variables": [ { "key": "envName", "value": "MyEnv" } ], "integration": { "identifier": "honeybadger" }, "environment": "$envName", "token": "84d1122d" } }, "New Relic notification (NEW_RELIC) ⚠️ DEPRECATED": { "description": "New Relic notification (NEW_RELIC) ⚠️ DEPRECATED", "value": { "name": "NEWRELIC Action", "type": "NEW_RELIC", "trigger_time": "ON_EVERY_EXECUTION", "version": "$BUDDY_RUN_COMMIT", "variables": [ { "key": "content", "value": "changelog content" } ], "description": "${BUDDY_PIPELINE_NAME} execution #${BUDDY_RUN_ID}", "changelog": "${content}", "application_id": "65867123", "integration": { "identifier": "newrelic" } } }, "Rollbar notification (ROLLBAR)": { "description": "Rollbar notification (ROLLBAR)", "value": { "name": "Rollbar Action", "type": "ROLLBAR", "trigger_time": "ON_EVERY_EXECUTION", "user": "mike", "rollbar_username": "MikeB", "application": "123456", "environment": "$envName", "comment": "Deploy comment", "variables": [ { "key": "envName", "value": "MyEnvironment" } ], "integration": { "identifier": "rollbar" } } }, "Sentry notification (SENTRY)": { "description": "Sentry notification (SENTRY)", "value": { "name": "Sentry Action", "type": "SENTRY", "trigger_time": "ON_EVERY_EXECUTION", "organization_slug": "buddyworks", "version": "${BUDDY_RUN_COMMIT}", "environment": "linux", "release_url": "${BUDDY_RUN_COMMIT_URL}", "deploy_url": "${BUDDY_RUN_URL}", "repository": "$BUDDY_REPO_SLUG", "projects": [ "java", "my_proj" ], "integration": { "identifier": "sentry" } } }, "Sentry notification (SENTRY_ENTERPRISE)": { "description": "Sentry notification (SENTRY_ENTERPRISE)", "value": { "name": "Sentry Enterprise Action", "type": "SENTRY_ENTERPRISE", "trigger_time": "ON_EVERY_EXECUTION", "organization_slug": "buddyworks", "version": "${BUDDY_RUN_COMMIT}", "environment": "linux", "release_url": "${BUDDY_RUN_COMMIT_URL}", "deploy_url": "${BUDDY_RUN_URL}", "repository": "$BUDDY_REPO_SLUG", "projects": [ "java", "my_proj" ], "integration": { "identifier": "sentry-enterprise" } } }, "Datadog notification (DATADOG)": { "description": "Datadog notification (DATADOG)", "value": { "name": "Datadog Action", "type": "DATADOG", "trigger_time": "ON_EVERY_EXECUTION", "alert_type": "warning", "variables": [ { "key": "aggregationKey", "value": "someValue" } ], "aggregation_key": "$aggregationKey", "host": "linux", "content": "And let me tell you all about it here!.", "title": "Something big happened!", "region": "EU1", "tags": [ "version:1", "application:web" ], "integration": { "identifier": "datadog" } } }, "Datadog Service Check (DATADOG_STATUS_CHECK)": { "description": "Datadog Service Check (DATADOG_STATUS_CHECK)", "value": { "name": "Datadog Status Check Action", "type": "DATADOG_STATUS_CHECK", "trigger_time": "ON_EVERY_EXECUTION", "variables": [ { "key": "datadogHost", "value": "linux" } ], "host_name": "$datadogHost", "status": 1, "check": "Pipeline Execution", "message": "And let me tell you all about it here!", "region": "EU1", "integration": { "identifier": "datadog" } } }, "Bugsnag (BUGSNAG)": { "description": "Bugsnag (BUGSNAG)", "value": { "name": "Bugsnag notification", "type": "BUGSNAG", "trigger_time": "ON_EVERY_EXECUTION", "version": "$BUDDY_RUN_ID", "release_stage": "$BUDDY_RUN_BRANCH", "token": "$apiKey", "revision": "$BUDDY_RUN_COMMIT", "variables": [ { "key": "apiKey", "value": "secure!rjMzYPhyffqEI8nmd4JPLuv51uhqpzJ4ykx+ilKrTgh9t4+/tGAPhF05EvhpdMj2", "encrypted": true } ], "builder_name": "$BUDDY_INVOKER_NAME", "auto_assign_release": true } }, "Raygun (RAYGUN)": { "description": "Raygun (RAYGUN)", "value": { "name": "Raygun notification", "type": "RAYGUN", "trigger_time": "ON_EVERY_EXECUTION", "variables": [ { "key": "token", "value": "secure!rjMzYPhyffqEI8nmd4JPLuv51uhqpzJ4ykx+ilKrTgh9t4+/tGAPhF05EvhpdMj2", "encrypted": true } ], "version": "$BUDDY_RUN_ID", "token": "$token", "api_key": "cgKu1yviT0HvlYecNEyFg", "email": "$BUDDY_INVOKER_EMAIL", "comment": "$BUDDY_INVOKER_COMMENT" } }, "Loggly (LOGGLY)": { "description": "Loggly (LOGGLY)", "value": { "name": "Loggly notification", "type": "LOGGLY", "trigger_time": "ON_EVERY_EXECUTION", "variables": [ { "key": "tag", "value": "customTag" } ], "integration": { "identifier": "loggly" }, "tags": [ "buddy", "${BUDDY_WORKSPACE_DOMAIN}", "${BUDDY_PROJECT_NAME}", "${BUDDY_PIPELINE_NAME}", "${tag}" ], "content": "Notification content" } }, "Ghost Inspector (GHOST_INSPECTOR)": { "description": "Ghost Inspector (GHOST_INSPECTOR)", "value": { "name": "Ghost Inspector Action", "type": "GHOST_INSPECTOR", "trigger_time": "ON_EVERY_EXECUTION", "variables": [ { "key": "filePath", "value": "variable.csv" } ], "user": "username", "password": "ha16@sdharj21529aA==", "immediate": false, "disable_notification": false, "region": "us-east-1", "browser": "opera", "suite": "5c9ca42171f823532163ef760", "folder": "5cd019551a5fads555105142", "channel": "slack_channel_name", "viewport": "5c9ca42171f8231b363ef760", "data_file": "$filePath", "start_url": "https://app.buddy.works/nickname", "user_agent": "usernameghost", "integration": { "identifier": "ghost-inspector" } } }, "Atop System Monitoring (ATOP)": { "description": "Atop System Monitoring (ATOP)", "value": { "name": "Monitor System Performance", "type": "ATOP", "trigger_time": "ON_EVERY_EXECUTION", "api_url": "https://monitoring.example.com/api/v1/metrics", "parameters": [ { "key": "interval", "value": "60" }, { "key": "duration", "value": "300" } ], "variables": [ { "key": "ATOP_OUTPUT", "value": "/workspace/atop-report.log" } ] } }, "DigitalOcean Spaces (DO_SPACES)": { "description": "DigitalOcean Spaces (DO_SPACES)", "value": { "name": "Upload files to DO Spaces", "type": "DO_SPACES", "input_type": "SCM_REPOSITORY", "trigger_time": "ON_EVERY_EXECUTION", "local_path": "/assets/", "remote_path": "Home/www/", "bucket_name": "buddy-tests", "public_access": true, "cache_control": "max-age=3600", "deployment_excludes": [ "/tmp/", "*.log" ], "deployment_includes": [ "/assets/style", "/tmp/file.txt" ], "integration": { "identifier": "digitalocean" } } }, "Backblaze B2 (BACKBLAZE_B2)": { "description": "Backblaze B2 (BACKBLAZE_B2)", "value": { "name": "Transfer to Backblaze B2", "type": "BACKBLAZE_B2", "input_type": "SCM_REPOSITORY", "trigger_time": "ON_EVERY_EXECUTION", "local_path": "/assets/", "remote_path": "Home/www/", "bucket_name": "buddy-tests", "region": "us-east-005", "cache_control": "max-age=3600", "deletion_disabled": true, "deployment_excludes": [ "/tmp/", "*.log" ], "deployment_includes": [ "/assets/style", "/tmp/file.txt" ], "integration": { "identifier": "backblaze" } } }, "Google Cloud Storage (GOOGLE_CLOUD_STORAGE)": { "description": "Google Cloud Storage (GOOGLE_CLOUD_STORAGE)", "value": { "name": "Upload files to GCS/hello-world-0", "type": "GOOGLE_CLOUD_STORAGE", "trigger_time": "ON_EVERY_EXECUTION", "input_type": "SCM_REPOSITORY", "local_path": "/assets", "remote_path": "/public", "bucket_name": "hello-world-0", "public_access": false, "application_name": "hello-world", "deployment_excludes": [ "/tmp/", "*.log" ], "deployment_includes": [ "/assets/style", "/tmp/file.txt" ], "integration": { "identifier": "gcp" } } }, "Google Cloud Storage (GCS) ⚠️ DEPRECATED": { "description": "Google Cloud Storage (GCS) ⚠️ DEPRECATED", "value": { "name": "Upload files to GCS/hello-world-0", "type": "GCS", "trigger_time": "ON_EVERY_EXECUTION", "input_type": "SCM_REPOSITORY", "local_path": "/assets", "remote_path": "/public", "bucket_name": "hello-world-0", "public_access": false, "application_name": "hello-world", "deployment_excludes": [ "/tmp/", "*.log" ], "deployment_includes": [ "/assets/style", "/tmp/file.txt" ], "integration": { "identifier": "gcp" } } }, "Rackspace (RACKSPACE)": { "description": "Rackspace (RACKSPACE)", "value": { "name": "Upload files to Rackspace", "type": "RACKSPACE", "input_type": "SCM_REPOSITORY", "trigger_time": "ON_EVERY_EXECUTION", "local_path": "/assets/", "remote_path": "Home/www/", "container": "buddy-tests", "region": "IAD", "deployment_excludes": [ "/tmp/", "*.log" ], "deployment_includes": [ "/assets/style", "/tmp/file.txt" ], "integration": { "identifier": "rackspace" } } }, "Shopify (SHOPIFY)": { "description": "Shopify (SHOPIFY)", "value": { "name": "Push to Shopify", "type": "SHOPIFY", "input_type": "SCM_REPOSITORY", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "shopify" }, "theme": "MyTheme", "deployment_excludes": [ "/tmp/", "*.log" ], "deployment_includes": [ "/assets/style", "/tmp/file.txt" ] } }, "WebDAV (WEB_DAV)": { "description": "WebDAV (WEB_DAV)", "value": { "name": "Upload files to localhost", "type": "WEB_DAV", "trigger_time": "ON_EVERY_EXECUTION", "web_dav_url": "https://mysite.com/webdav/", "login": "webdav", "password": "webdav123", "input_type": "SCM_REPOSITORY", "local_path": "/assets/", "remote_path": "Home/www/", "deployment_excludes": [ "/tmp/", "*.log" ], "deployment_includes": [ "/assets/style", "/tmp/file.txt" ] } }, "Transfer (TRANSFER)": { "description": "Transfer (TRANSFER)", "value": { "name": "Upload files to 192.0.2.1 by FTP", "type": "TRANSFER", "trigger_time": "ON_EVERY_EXECUTION", "input_type": "SCM_REPOSITORY", "local_path": "/", "remote_path": "", "compress": true, "targets": [ { "identifier": "ftp_target_1", "type": "FTP", "secure": false, "host": "192.0.2.1", "port": "21", "auth": { "username": "user", "password": "$MyPassword" }, "path": "/var/www" } ] } }, "Azure Storage (AZURE_STORAGE)": { "description": "Azure Storage (AZURE_STORAGE)", "value": { "name": "Upload files to Azure Storage", "type": "AZURE_STORAGE", "input_type": "BUILD_ARTIFACTS", "trigger_time": "ON_EVERY_EXECUTION", "local_path": "/assets", "remote_path": "/remote", "bucket_name": "buddytest", "deletion_disabled": true, "integration": { "identifier": "azure" }, "application_name": "buddytests", "skip_content_type_setting": false, "deployment_excludes": [ "/tmp/", "*.log" ], "deployment_includes": [ "/assets/style", "/tmp/file.txt" ] } }, "Deploy to Sandbox (DEPLOY_TO_SANDBOX) ⚠️ DEPRECATED": { "description": "Deploy to Sandbox (DEPLOY_TO_SANDBOX) ⚠️ DEPRECATED", "value": { "name": "Deploy to Development Sandbox", "type": "DEPLOY_TO_SANDBOX", "trigger_time": "ON_EVERY_EXECUTION", "sandbox_id": "ghwmnj2az2k67", "sandbox_references": [ "BY_ID" ], "local_path": "/dist", "remote_path": "/var/www/app", "user": "www-data", "input_type": "BUILD_ARTIFACTS", "deployment_excludes": [ "*.log", "*.tmp", "node_modules/*" ], "deployment_includes": [ "**/*.html", "**/*.js", "**/*.css" ], "deletion_disabled": false, "use_temporary_files": true } }, "Publish Artifact (PUBLISH_ARTIFACT_VERSION)": { "description": "Publish Artifact (PUBLISH_ARTIFACT_VERSION)", "value": { "name": "Publish NPM Artifact", "type": "PUBLISH_ARTIFACT_VERSION", "trigger_time": "ON_EVERY_EXECUTION", "artifact": "my-company/ui-components", "versions": [ "3.2.1" ], "local_path": "/dist", "remote_path": "/artifacts", "input_type": "BUILD_ARTIFACTS", "deployment_excludes": [ "*.map", "*.test.js" ], "deployment_includes": [ "**/*.js", "**/*.css", "package.json" ], "deletion_disabled": true } }, "Powershell Command (POWERSHELL)": { "description": "Powershell Command (POWERSHELL)", "value": { "name": "Deploy PowerShell Scripts to Windows Server", "type": "POWERSHELL", "trigger_time": "ON_EVERY_EXECUTION", "working_directory": "C:\\Deployment\\Scripts", "commands": [ "Write-Host \"Starting deployment\"", "Stop-Service MyAppService -Force", "Copy-Item -Path .\\* -Destination C:\\Apps\\MyApp -Recurse -Force", "Start-Service MyAppService", "Get-Service MyAppService" ], "targets": [ { "type": "SSH", "identifier": "prod_win_server", "host": "10.0.1.50", "port": "22", "auth": { "method": "PASSWORD", "username": "deploy_user", "password": "$DEPLOY_PASSWORD" } } ], "run_as_script": true, "execute_every_command": false } }, "Execute in Sandbox (SANDBOX_EXEC) ⚠️ DEPRECATED": { "description": "Execute in Sandbox (SANDBOX_EXEC) ⚠️ DEPRECATED", "value": { "name": "Run Database Migrations", "type": "SANDBOX_EXEC", "trigger_time": "ON_EVERY_EXECUTION", "sandbox_id": "ghwmnj2az2k67", "sandbox_references": [ "BY_ID" ], "working_directory": "/var/www/app", "commands": [ "php artisan migrate --force", "php artisan cache:clear" ], "shell": "bash", "execute_every_command": true, "user": "www-data" } }, "Git Push (PUSH)": { "description": "Git Push (PUSH)", "value": { "name": "Push to GitHub repo", "disabled": true, "type": "PUSH", "trigger_time": "ON_EVERY_EXECUTION", "trigger_conditions": [ { "trigger_condition": "ON_CHANGE" }, { "trigger_condition": "HOUR", "trigger_hours": [ 8, 9, 10 ], "timezone": "Europe/Warsaw" } ], "deployment_excludes": [ "/assets/", "/myDir" ], "targets": [ { "identifier": "git-push", "name": "my-git-target", "type": "GIT", "auth": { "username": "user", "password": "pass1234", "method": "HTTP" }, "repository": "https://github.com/example/my-repository" } ], "target_branch": "BUDDY_EXECUTION_BRANCH", "tag": "tagName", "custom_options": "--no-verify", "comment": "BUDDY_RUN_ID", "isolated": false, "push_tags": true, "use_custom_gitignore": true, "without_force": false, "timeout": 1800, "retry_interval": 60, "retry_count": 5, "ignore_errors": true, "current_revision": "21825f31ddce8a89b3ed9f4c92f038b339cde150" } }, "Azure (AZURE)": { "description": "Azure (AZURE)", "value": { "name": "Push to Your Repo", "type": "AZURE", "git_auth_mode": "HTTP", "trigger_time": "ON_EVERY_EXECUTION", "push_url": "https://buddytestapp.scm.azurewebsites.net:443/BuddyTestApp.git", "login": "api_tests_user", "password": "api_tests_password", "isolated": true, "target_branch": "stage", "deployment_excludes": [ "/tmp/", "*.log" ] } }, "Heroku (HEROKU)": { "description": "Heroku (HEROKU)", "value": { "name": "Push to Your Repo", "type": "HEROKU", "trigger_time": "ON_EVERY_EXECUTION", "use_custom_gitignore": true, "isolated": true, "integration": { "identifier": "heroku" }, "application_name": "AppName", "deployment_excludes": [ "/tmp/", "*.log" ] } }, "Web monitoring (WEB)": { "description": "Web monitoring (WEB)", "value": { "name": "Check http://buddy.works/ status", "type": "WEB", "trigger_time": "ON_EVERY_EXECUTION", "login": "owner@buddy.works", "password": "secure!TPR+DWaI7z47j6Ns4kkSJQ==", "port": "8080", "destination": "http://buddy.works/", "post_data": "{ \"test\": \"ok\" }", "headers": [ { "name": "User-Agent", "value": "Buddy" }, { "name": "myHeader", "value": "myHeaderValue" } ], "text_existence": true, "text": "ok" } }, "TCP monitoring (TCP)": { "description": "TCP monitoring (TCP)", "value": { "name": "Check site status", "type": "TCP", "trigger_time": "ON_EVERY_EXECUTION", "variables": [ { "key": "hostName", "value": "app.buddy.works" } ], "port": "8080", "destination": "$hostName", "post_data": "{ \"test\": \"ok\" }", "text": "ok" } }, "Ping monitoring (PING)": { "description": "Ping monitoring (PING)", "value": { "name": "Ping Action", "type": "PING", "trigger_time": "ON_EVERY_EXECUTION", "destination": "$host", "variables": [ { "key": "host", "value": "app.buddy.works" } ] } }, "Playwright Tests (PLAYWRIGHT)": { "description": "Playwright Tests (PLAYWRIGHT)", "value": { "name": "Run Playwright E2E Tests", "type": "PLAYWRIGHT", "trigger_time": "ON_EVERY_EXECUTION", "working_directory": "/", "docker_image_name": "node", "docker_image_tag": "20", "setup_commands": [ "npx playwright install --with-deps" ], "execute_commands": [ "npx playwright test" ], "cached_dirs": [ "node_modules" ] } }, "Build Storybook (STORYBOOK)": { "description": "Build Storybook (STORYBOOK)", "value": { "name": "Build Component Documentation", "type": "STORYBOOK", "trigger_time": "ON_EVERY_EXECUTION", "working_directory": "/", "docker_image_name": "node", "docker_image_tag": "20-alpine", "setup_commands": [ "npm ci" ], "execute_commands": [ "npm run build-storybook" ], "execute_every_command": true, "cached_dirs": [ "node_modules" ], "export_container_path": "/storybook-static" } }, "Cypress Tests (CYPRESS)": { "description": "Cypress Tests (CYPRESS)", "value": { "name": "Run Cypress E2E Tests", "type": "CYPRESS", "trigger_time": "ON_EVERY_EXECUTION", "working_directory": "/", "docker_image_name": "cypress/included", "docker_image_tag": "latest", "execute_commands": [ "npx cypress run" ], "cached_dirs": [ "node_modules", ".cypress" ] } }, "Custom Action (CUSTOM)": { "description": "Custom Action (CUSTOM)", "value": { "name": "My custom action", "type": "CUSTOM", "trigger_time": "ON_EVERY_EXECUTION", "custom_type": "my_custom_action:latest", "variables_access": true, "filesystem_access": true, "inputs": [ { "id": "cmd", "value": "echo 'Hello world'" }, { "id": "other_custom_input", "value": "some value" } ] } }, "Run Docker container (RUN_DOCKER_CONTAINER)": { "description": "Run Docker container (RUN_DOCKER_CONTAINER)", "value": { "name": "Run container", "type": "RUN_DOCKER_CONTAINER", "trigger_time": "ON_EVERY_EXECUTION", "docker_image_name": "library/ubuntu", "docker_image_tag": "latest", "inline_commands": "ls -al > ls.log", "run_as_user": "$containerUser", "mount_filesystem_disable": false, "export_container_path": "/exportPath", "volume_mappings": [ "/:/buddy/mount/directory" ], "integration": { "identifier": "docker-registry" }, "variables": [ { "key": "containerUser", "value": "notRoot" } ], "entrypoint": "/bin/sh" } }, "Build Docker Image (DOCKERFILE)": { "description": "Build Docker Image (DOCKERFILE)", "value": { "name": "Build dockerfile", "type": "DOCKERFILE", "trigger_time": "ON_EVERY_EXECUTION", "docker_image_tag": "14.06", "region": "us-east-1", "integration": { "identifier": "docker-registry" }, "dockerfile_path": "dir/Dockerfile", "repository": "MyDockerRepo", "insecure_registry": true, "do_not_prune_images": true, "secrets": [ { "id": "someSecret", "value": "path_to_secret", "type": "FILE" }, { "id": "mysecret", "value": "MY_ENV_VAR_KEY", "type": "ENV" } ], "build_args": [ "key=value" ] } }, "Build multi-arch image (DOCKER_BUILD_MULTI_ARCH)": { "description": "Build multi-arch image (DOCKER_BUILD_MULTI_ARCH)", "value": { "name": "Build multi-arch image", "type": "DOCKER_BUILD_MULTI_ARCH", "trigger_time": "ON_EVERY_EXECUTION", "build_args": [ "key=value" ], "dockerfile_path": "Dockerfile", "context_path": "/contextPath", "target_stage": "$targetStage", "secrets": [ { "id": "$secretId", "value": "$path_to_secret", "type": "FILE" } ], "target_platform": "linux/amd64,linux/arm64" } }, "Push Docker Image (DOCKER_PUSH)": { "description": "Push Docker Image (DOCKER_PUSH)", "value": { "name": "Push to registry", "type": "DOCKER_PUSH", "trigger_time": "ON_EVERY_EXECUTION", "docker_image_tag": "14.06", "region": "us-east-1", "integration": { "identifier": "docker-registry" }, "docker_build_action_id": 1, "repository": "MyDockerRepo" } }, "Google App Engine (GOOGLE_APP_DEPLOY)": { "description": "Google App Engine (GOOGLE_APP_DEPLOY)", "value": { "name": "Deploy to Google App Engine/buddy-tests-112923", "type": "GOOGLE_APP_DEPLOY", "trigger_time": "ON_EVERY_EXECUTION", "local_path": "/", "bucket_name": "artifacts.tokyo-house-112923.appspot.com", "application_name": "buddy-tests-112923", "version_label": "${BUDDY_RUN_COMMIT}", "image_url": "gcr.io/your-project-id/your-image", "promote_all_traffic": true, "stop_previous_version": true, "verbosity": "warning" } }, "Google App Engine (GOOGLE_APP_ENGINE) ⚠️ DEPRECATED": { "description": "Google App Engine (GOOGLE_APP_ENGINE) ⚠️ DEPRECATED", "value": { "name": "Deploy to Google App Engine/buddy-tests-112923", "type": "GOOGLE_APP_ENGINE", "trigger_time": "ON_EVERY_EXECUTION", "local_path": "/", "bucket_name": "artifacts.tokyo-house-112923.appspot.com", "application_name": "buddy-tests-112923", "version_label": "${BUDDY_RUN_COMMIT}", "image_url": "gcr.io/your-project-id/your-image", "promote_all_traffic": true, "stop_previous_version": true, "verbosity": "warning" } }, "Google Cloud CLI (GOOGLE_CLOUD_CLI)": { "description": "Google Cloud CLI (GOOGLE_CLOUD_CLI)", "value": { "name": "Execute: gcloud version", "type": "GOOGLE_CLOUD_CLI", "trigger_time": "ON_EVERY_EXECUTION", "setup_commands": [ "apt-get update && apt-get -y install git" ], "execute_commands": [ "gcloud version" ], "shell": "SH", "version": "521.0.0", "application_name": "boxwood-builder-150909", "integration": { "identifier": "gcp" } } }, "GCloud CLI (GCLOUD_CLI) ⚠️ DEPRECATED": { "description": "GCloud CLI (GCLOUD_CLI) ⚠️ DEPRECATED", "value": { "name": "Execute: gcloud version", "type": "GCLOUD_CLI", "trigger_time": "ON_EVERY_EXECUTION", "setup_commands": [ "apt-get update && apt-get -y install git" ], "execute_commands": [ "gcloud version" ], "shell": "SH", "version": "521.0.0", "application_name": "boxwood-builder-150909", "integration": { "identifier": "gcp" } } }, "Google Cloud Run Deploy (GOOGLE_CLOUD_RUN_DEPLOY)": { "description": "Google Cloud Run Deploy (GOOGLE_CLOUD_RUN_DEPLOY)", "value": { "name": "Deploy to Google Cloud Run/84 tests", "type": "GOOGLE_CLOUD_RUN_DEPLOY", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "gcp" }, "application_name": "MyApp", "region": "europe-west1", "service": "$service", "image": "$image", "platform": "MANAGED" } }, "GCloud Run Deploy (GCLOUD_RUN_DEPLOY) ⚠️ DEPRECATED": { "description": "GCloud Run Deploy (GCLOUD_RUN_DEPLOY) ⚠️ DEPRECATED", "value": { "name": "Deploy to Google Cloud Run/84 tests", "type": "GCLOUD_RUN_DEPLOY", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "gcp" }, "application_name": "MyApp", "region": "europe-west1", "service": "$service", "image": "$image", "platform": "MANAGED" } }, "Heroku CLI (HEROKU_CLI)": { "description": "Heroku CLI (HEROKU_CLI)", "value": { "name": "Execute commands on Heroku", "type": "HEROKU_CLI", "trigger_time": "ON_EVERY_EXECUTION", "variables": [ { "key": "appName", "value": "my-app" } ], "setup_commands": [ "apt-get update && apt-get -y install git" ], "execute_commands": [ "heroku run ls -al --app $appName" ], "shell": "SH", "application_name": "AppName", "integration": { "identifier": "heroku" } } }, "AWS CLI (AWS_CLI)": { "description": "AWS CLI (AWS_CLI)", "value": { "name": "Run AWS command", "type": "AWS_CLI", "trigger_time": "ON_EVERY_EXECUTION", "setup_commands": [ "apt-get update && apt-get -y install git" ], "execute_commands": [ "aws lambda $command" ], "shell": "SH", "variables": [ { "key": "command", "value": "list-functions" } ], "integration": { "identifier": "aws" }, "region": "us-west-2" } }, "AWS CLI 2 (AWS_CLI_2)": { "description": "AWS CLI 2 (AWS_CLI_2)", "value": { "name": "Execute: aws lambda list-functions", "type": "AWS_CLI_2", "trigger_time": "ON_EVERY_EXECUTION", "setup_commands": [ "apt-get update && apt-get -y install git" ], "execute_commands": [ "aws lambda list-functions" ], "shell": "SH", "integration": { "identifier": "aws" }, "region": "us-west-2" } }, "AWS CloudFormation (AWS_CLOUD_FORMATION)": { "description": "AWS CloudFormation (AWS_CLOUD_FORMATION)", "value": { "name": "Execute: create CloudFormation", "disabled": true, "type": "AWS_CLOUD_FORMATION", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "yfsctqutdt", "name": "slskopytko", "type": "AMAZON", "scope": "WORKSPACE" }, "region": "us-west-2", "execute_commands": [ "#VALIDATE", "aws cloudformation validate-template --template-body file:///stacks/sampletemplate.json", "#CREATE", "aws cloudformation create-stack --stack-name testsstack --template-body file:///stacks/sampletemplate.json --parameters ParameterKey=Key1,ParameterValue=Val1 --tags Key=Env,Value=ENV", "#WAIT UNTIL READY", "aws cloudformation wait stack-create-complete --stack-name testsstack" ], "setup_commands": [ "apt-get update", "apt-get install -y curl" ], "variables": [ { "key": "env_key", "value": "env_value", "type": "VAR", "settable": false, "run_only_settable": false, "encrypted": false, "description": "gwghjuafon" } ], "timeout": 1800, "retry_interval": 60, "retry_count": 5, "ignore_errors": true, "current_revision": "21825f31ddce8a89b3ed9f4c92f038b339cde150", "loop": [ "env_key" ] } }, "AWS Lambda Deploy (AWS_LAMBDA_DEPLOY)": { "description": "AWS Lambda Deploy (AWS_LAMBDA_DEPLOY)", "value": { "name": "Deploy function hello-world", "type": "AWS_LAMBDA_DEPLOY", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "aws" }, "region": "us-east-1", "function_name": "hello-world", "local_path": "/", "deployment_excludes": [ "/tmp/", "*.log" ], "deployment_includes": [ "/assets/style", "/tmp/file.txt" ] } }, "Google Function Deploy (GOOGLE_FUNCTION_DEPLOY)": { "description": "Google Function Deploy (GOOGLE_FUNCTION_DEPLOY)", "value": { "name": "Deploy function hello-world", "type": "GOOGLE_FUNCTION_DEPLOY", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "gcp" }, "application_id": "hello-world", "function_name": "hello-world-0", "command_args": "--trigger-http", "runtime": "nodejs12", "local_path": "/", "region": "europe-west3" } }, "Google Functions Deploy (GOOGLE_FUNCTIONS_DEPLOY) ⚠️ DEPRECATED": { "description": "Google Functions Deploy (GOOGLE_FUNCTIONS_DEPLOY) ⚠️ DEPRECATED", "value": { "name": "Deploy function hello-world", "type": "GOOGLE_FUNCTIONS_DEPLOY", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "gcp" }, "application_id": "hello-world", "function_name": "hello-world-0", "command_args": "--trigger-http", "runtime": "nodejs12", "local_path": "/", "region": "europe-west3" } }, "Trigger pipeline (RUN_NEXT_PIPELINE)": { "description": "Trigger pipeline (RUN_NEXT_PIPELINE)", "value": { "name": "Trigger Pipeline Action", "type": "RUN_NEXT_PIPELINE", "trigger_time": "ON_EVERY_EXECUTION", "environment": "$BUDDY_RUN_ENV_ID", "comment": "Triggered by $BUDDY_PIPELINE_NAME execution #$BUDDY_EXECUTION_ID", "next_pipeline": { "id": 185088 }, "revision": "SPECIFIC", "specific_revision": "#$BUDDY_EXECUTION_REF", "wait": true, "clear_cache": true, "refresh": true, "priority": "LOW", "variables": [ { "key": "key", "value": "buddy", "type": "VAR", "settable": true, "description": "" } ], "artifact": "$BUDDY_RUN_ARTIFACT_VERSION" } }, "Copy files (COPY_FILES)": { "description": "Copy files (COPY_FILES)", "value": { "name": "Copy files from another pipeline", "type": "COPY_FILES", "copy_hidden_files": true, "trigger_time": "ON_EVERY_EXECUTION", "source_pipeline": { "id": 2 }, "target_pipeline": { "id": 3 }, "source_path": "/", "target_path": "Home/www/", "deployment_excludes": [ "/tmp/", "*.log" ], "deployment_includes": [ "/assets/style", "/tmp/file.txt" ] } }, "Wait for apply (WAIT_FOR_APPLY)": { "description": "Wait for apply (WAIT_FOR_APPLY)", "value": { "name": "Wait for manual apply", "type": "WAIT_FOR_APPLY", "trigger_time": "ON_EVERY_EXECUTION", "comment": "Do you want to deploy ${BUDDY_RUN_COMMIT} to Production?", "prevent_self_approval": true, "permissions": { "others": "DENIED", "users": [ { "id": 1, "access_level": "ALLOWED" } ], "groups": [ { "id": 1, "access_level": "ALLOWED" } ] } } }, "Pass arguments (WAIT_FOR_VARIABLES)": { "description": "Pass arguments (WAIT_FOR_VARIABLES)", "value": { "name": "Pass parameters", "type": "WAIT_FOR_VARIABLES", "trigger_time": "ON_EVERY_EXECUTION", "comment": "Version should be like X.Y.Z", "variables": [ { "key": "version" }, { "key": "pass", "encrypted": true } ], "permissions": { "others": "DENIED", "users": [ { "id": 1, "access_level": "ALLOWED" } ], "groups": [ { "id": 1, "access_level": "ALLOWED" } ] } } }, "Set variables (SET_VARIABLES)": { "description": "Set variables (SET_VARIABLES)", "value": { "name": "Set Variables", "type": "SET_VARIABLES", "trigger_time": "ON_EVERY_EXECUTION", "comment": "comment", "variables": [ { "key": "var3", "init_path": "/fileWithOptions" }, { "key": "var2", "defaults": "option1\noption2" }, { "key": "var1" }, { "key": "var4" } ], "permissions": { "others": "DENIED", "users": [ { "id": 1, "access_level": "ALLOWED" } ], "groups": [ { "id": 1, "access_level": "ALLOWED" } ] } } }, "Approve VT (APPROVE_VT)": { "description": "Approve VT (APPROVE_VT)", "value": { "name": "Wait for VT approve", "type": "APPROVE_VT", "trigger_time": "ON_EVERY_EXECUTION", "comment": "Please review and approve the visual tests", "description": "Waiting for visual test session approval", "from_action": "Visual tests", "ref": "refs/heads/main", "permissions": { "others": "DENIED", "users": [ { "id": 1, "access_level": "ALLOWED" } ], "groups": [ { "id": 1, "access_level": "ALLOWED" } ] } } }, "Elastic Beanstalk (ELASTIC_BEANSTALK)": { "description": "Elastic Beanstalk (ELASTIC_BEANSTALK)", "value": { "name": "Upload files to Elastic Beanstalk/tests", "type": "ELASTIC_BEANSTALK", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "aws" }, "application_name": "tests", "region": "us-east-1", "environment": "e-rnuptbebz2", "version_label": "NewVersion", "deployment_excludes": [ "/tmp/", "*.log" ], "deployment_includes": [ "/assets/style", "/tmp/file.txt" ] } }, "Code Deploy (CODE_DEPLOY)": { "description": "Code Deploy (CODE_DEPLOY)", "value": { "name": "Upload files to Code Deploy", "type": "CODE_DEPLOY", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "aws" }, "local_path": "/", "application_name": "tests", "region": "us-east-1", "group_name": "DemoFleet", "config_name": "CodeDeployDefault.OneAtATime", "description": "Deploy comment.", "ignore_application_stop_failures": false, "update_outdated_instances_only": false, "wait_for_finish_deployment": true, "file_exist_behavior": "OVERWRITE", "deployment_excludes": [ "/tmp/", "*.log" ], "deployment_includes": [ "/assets/style", "/tmp/file.txt" ] } }, "AWS App Runner Deploy (AWS_APP_RUNNER_DEPLOY)": { "description": "AWS App Runner Deploy (AWS_APP_RUNNER_DEPLOY)", "value": { "name": "App Runner Deploy", "type": "AWS_APP_RUNNER_DEPLOY", "trigger_time": "ON_EVERY_EXECUTION", "service": "arn-aws-apprunner-service", "region": "us-east-1", "integration": { "identifier": "aws" } } }, "AWS ECS (AWS_ECS)": { "description": "AWS ECS (AWS_ECS)", "value": { "name": "ECS by API", "type": "AWS_ECS", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "aws" }, "service": "sample-app-service", "cluster": "buddy-testing-cluster", "local_path": "taskDefinition.json", "region": "us-east-1" } }, "AWS Lambda (LAMBDA)": { "description": "AWS Lambda (LAMBDA)", "value": { "name": "Invoke function hello-world", "type": "LAMBDA", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "aws" }, "region": "us-east-1", "function_name": "hello-world", "qualifier": "", "invocation_type": "RequestResponse", "log_type": "Tail", "client_context": "", "payload": "{ \"revision\": \"${BUDDY_RUN_COMMIT}\", \"message\": \"${BUDDY_RUN_COMMIT_MESSAGE}\" }" } }, "Google Functions (GOOGLE_FUNCTIONS) ⚠️ DEPRECATED": { "description": "Google Functions (GOOGLE_FUNCTIONS) ⚠️ DEPRECATED", "value": { "name": "Invoke function hello-world-0", "type": "GOOGLE_FUNCTIONS", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "gcp" }, "function_name": "hello-world-0", "payload": "{ \"revision\": \"$BUDDY_RUN_COMMIT\", \"message\": \"$BUDDY_RUN_COMMIT_MESSAGE\" }" } }, "Google Function Invoke (GOOGLE_FUNCTION_INVOKE)": { "description": "Google Function Invoke (GOOGLE_FUNCTION_INVOKE)", "value": { "name": "Invoke function hello-world-0", "type": "GOOGLE_FUNCTION_INVOKE", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "gcp" }, "function_name": "hello-world-0", "payload": "{ \"revision\": \"$BUDDY_RUN_COMMIT\", \"message\": \"$BUDDY_RUN_COMMIT_MESSAGE\" }" } }, "Cloudflare (CLOUDFLARE)": { "description": "Cloudflare (CLOUDFLARE)", "value": { "name": "Cloudflare action", "type": "CLOUDFLARE", "trigger_time": "ON_EVERY_EXECUTION", "input_type": "SCM_REPOSITORY", "local_path": "/", "zone_id": "f00e1e106ca13e658477bf7393ad83f1", "base_url": "https://buddy.works", "purge_all": false, "integration": { "identifier": "cloudflare" }, "deployment_excludes": [ "/tmp/", "*.log" ], "deployment_includes": [ "/assets/style", "/tmp/file.txt" ] } }, "CloudFront (CLOUD_FRONT)": { "description": "CloudFront (CLOUD_FRONT)", "value": { "name": "Cloudfront action", "type": "CLOUD_FRONT", "trigger_time": "ON_EVERY_EXECUTION", "input_type": "SCM_REPOSITORY", "local_path": "/", "base_url": "/merged", "distribution_id": "EDFDVBD632BHDS5", "purge_all": false, "timeout": 900, "integration": { "identifier": "aws" }, "deployment_excludes": [ "/tmp/", "*.log" ], "deployment_includes": [ "/assets/style", "/tmp/file.txt" ] } }, "Google CDN (GOOGLE_CDN_INVALIDATE)": { "description": "Google CDN (GOOGLE_CDN_INVALIDATE)", "value": { "name": "Purge cache at hello-world / hello-world-cdn", "type": "GOOGLE_CDN_INVALIDATE", "trigger_time": "ON_EVERY_EXECUTION", "input_type": "SCM_REPOSITORY", "remote_path": "/merged", "distribution_id": "hello-world", "purge_all": false, "url_map": "hello-world-cdn", "integration": { "identifier": "gcp" }, "deployment_excludes": [ "/tmp/", "*.log" ], "deployment_includes": [ "/tmp/assets", "/tmp/styles" ] } }, "Google CDN (GOOGLE_CDN) ⚠️ DEPRECATED": { "description": "Google CDN (GOOGLE_CDN) ⚠️ DEPRECATED", "value": { "name": "Purge cache at hello-world / hello-world-cdn", "type": "GOOGLE_CDN", "trigger_time": "ON_EVERY_EXECUTION", "input_type": "SCM_REPOSITORY", "remote_path": "/merged", "distribution_id": "hello-world", "purge_all": false, "url_map": "hello-world-cdn", "integration": { "identifier": "gcp" }, "deployment_excludes": [ "/tmp/", "*.log" ], "deployment_includes": [ "/tmp/assets", "/tmp/styles" ] } }, "DigitalOcean CDN (DIGITAL_OCEAN_CDN)": { "description": "DigitalOcean CDN (DIGITAL_OCEAN_CDN)", "value": { "name": "DigitalOcean CDN", "type": "DIGITAL_OCEAN_CDN", "trigger_time": "ON_EVERY_EXECUTION", "input_type": "SCM_REPOSITORY", "local_path": "/", "remote_path": "/merged", "endpoint": "df590699-f862-45d1-aad0-0e74280ebe50", "purge_all": false, "integration": { "identifier": "digitalocean" }, "deployment_excludes": [ "/tmp/", "*.log" ], "deployment_includes": [ "/assets/style", "/tmp/file.txt" ] } }, "Rsync (RSYNC)": { "description": "Rsync (RSYNC)", "value": { "name": "Sync files", "disabled": true, "type": "RSYNC", "trigger_time": "ON_EVERY_EXECUTION", "local_path": "/source_path", "remote_path": "/target_path", "deployment_excludes": [ "/assets/", "/myDir" ], "deployment_includes": [ "/assets/dir", "/myDir/dir1" ], "archive": false, "compress": false, "recursive": true, "dirs": true, "delete_extra_files": true, "targets": [ { "identifier": "my_target_id", "name": "my-target", "type": "SSH", "scope": "ACTION", "path": "target/path/on/server", "host": "my-server.tests", "port": "1234", "auth": { "username": "my-user", "password": "my-password", "method": "PASSWORD" }, "tags": [ "olive", "orange", "rabsperry" ] } ], "variables": [ { "key": "env_key", "value": "env_value", "type": "VAR", "settable": false, "run_only_settable": false, "encrypted": false, "description": "nnnmstgikb" } ], "timeout": 1800, "retry_interval": 60, "retry_count": 5, "ignore_errors": true, "arguments": "--times --links", "current_revision": "21825f31ddce8a89b3ed9f4c92f038b339cde150", "loop": [ "env_key" ] } }, "Elastic Beanstalk Monitor (MONITOR)": { "description": "Elastic Beanstalk Monitor (MONITOR)", "value": { "name": "Monitor Elastic Beanstalk/tests", "type": "MONITOR", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "aws" }, "application_name": "tests", "region": "us-west-2", "environment": "e-rnuptbebz2", "fail_on_yellow": true, "verbose": false, "timeout": 600 } }, "AWS App Runner Monitor (AWS_APP_RUNNER_MONITOR)": { "description": "AWS App Runner Monitor (AWS_APP_RUNNER_MONITOR)", "value": { "name": "App Runner Monitor", "type": "AWS_APP_RUNNER_MONITOR", "trigger_time": "ON_EVERY_EXECUTION", "service": "arn-aws-apprunner-service", "region": "us-east-1", "integration": { "identifier": "aws" }, "timeout": 5400 } }, "Sleep (SLEEP)": { "description": "Sleep (SLEEP)", "value": { "name": "Sleep well, darling", "type": "SLEEP", "trigger_time": "ON_EVERY_EXECUTION", "sleep_in_sec": 600 } }, "GKE Apply Deployment (KUBERNETES_APPLY)": { "description": "GKE Apply Deployment (KUBERNETES_APPLY)", "value": { "name": "Apply deployment", "type": "KUBERNETES_APPLY", "trigger_time": "ON_EVERY_EXECUTION", "targets": [ { "zone": "europe-west1-c", "project_id": "tokyo-house-138923", "identifier": "my_target_id", "name": "my-target", "integration": "5ddb7c180fb38be67bd78a88a", "type": "GKE", "scope": "ACTION", "tags": [ "olive", "orange", "rabsperry" ], "cluster": "cluster-1" } ], "config_path": "config.yaml", "record_arg": "NOT_SET", "save_config_arg": false, "force_arg": false, "overwrite_arg": false, "cascade_arg": false, "all_arg": true, "grace_period_arg": 0, "prune_arg": true, "prune_whitelist_arg": "", "timeout": "600" } }, "GKE Set Image (KUBERNETES_SET_IMAGE)": { "description": "GKE Set Image (KUBERNETES_SET_IMAGE)", "value": { "name": "Set image", "type": "KUBERNETES_SET_IMAGE", "trigger_time": "ON_EVERY_EXECUTION", "targets": [ { "zone": "europe-west1-c", "project_id": "tokyo-house-138923", "identifier": "my_target_id", "name": "my-target", "integration": "5ddb7c180fb38be67bd78a88a", "type": "GKE", "scope": "ACTION", "tags": [ "olive", "orange", "rabsperry" ], "cluster": "cluster-1" } ], "deployment": "nginx-deployment", "namespace": "default", "image_name": "nginx", "image_tag": "1.7.8", "record_arg": "NOT_SET", "container": "nginx" } }, "GKE Run Pod (KUBERNETES_RUN_POD)": { "description": "GKE Run Pod (KUBERNETES_RUN_POD)", "value": { "name": "Run Pod", "type": "KUBERNETES_RUN_POD", "trigger_time": "ON_EVERY_EXECUTION", "targets": [ { "zone": "europe-west1-c", "project_id": "tokyo-house-138923", "identifier": "my_target_id", "name": "my-target", "integration": "5ddb7c180fb38be67bd78a88a", "type": "GKE", "scope": "ACTION", "tags": [ "olive", "orange", "rabsperry" ], "cluster": "cluster-1" } ], "record_arg": "NOT_SET", "leave_after": true, "not_wait": true, "config_path": "config.yaml" } }, "GKE Run Job (KUBERNETES_RUN_JOB)": { "description": "GKE Run Job (KUBERNETES_RUN_JOB)", "value": { "name": "Run job", "type": "KUBERNETES_RUN_JOB", "trigger_time": "ON_EVERY_EXECUTION", "targets": [ { "zone": "europe-west1-c", "project_id": "tokyo-house-138923", "identifier": "my_target_id", "name": "my-target", "integration": "5ddb7c180fb38be67bd78a88a", "type": "GKE", "scope": "ACTION", "tags": [ "olive", "orange", "rabsperry" ], "cluster": "cluster-1" } ], "record_arg": "NOT_SET", "leave_after": true, "not_wait": true, "config_path": "config.yaml" } }, "GKE kubectl (KUBERNETES_CLI)": { "description": "GKE kubectl (KUBERNETES_CLI)", "value": { "name": "GKE CLI", "disabled": true, "type": "KUBERNETES_CLI", "trigger_time": "ON_EVERY_EXECUTION", "targets": [ { "zone": "europe-west3-a", "project_id": "tests-buddy", "identifier": "my_target_id", "name": "my-target", "integration": "hlgqrrbcni", "type": "GKE", "scope": "ACTION", "tags": [ "olive", "orange", "rabsperry" ], "cluster": "buddy-tests" } ], "execute_commands": [ "kubectl get namespaces -o=custom-columns=NAME:.metadata.name", "cat ~/.kube/config" ], "execute_every_command": true, "setup_commands": [ "apt-get update" ], "variables": [ { "key": "env_key", "value": "env_value", "type": "VAR", "settable": false, "run_only_settable": false, "encrypted": false, "description": "vnxmrlbjgo" } ], "shell": "BASH", "kubectl_version": "latest", "timeout": 1800, "retry_interval": 60, "retry_count": 5, "ignore_errors": true, "current_revision": "21825f31ddce8a89b3ed9f4c92f038b339cde150", "loop": [ "env_key" ] } }, "MySQL CLI (MYSQL_CLI)": { "description": "MySQL CLI (MYSQL_CLI)", "value": { "name": "Run MySQL queries", "type": "MYSQL_CLI", "trigger_time": "ON_EVERY_EXECUTION", "version": "8.0", "shell": "BASH", "execute_commands": [ "mysql -e 'SHOW DATABASES'", "mysql < migrate.sql" ], "targets": [ { "identifier": "my_database", "name": "My MySQL Database", "type": "MYSQL", "scope": "ACTION", "host": "db.example.com", "port": 3306, "database": "myapp", "auth": { "method": "PASSWORD", "username": "deploy_user", "password": "secured" } } ] } }, "PostgreSQL CLI (POSTGRESQL_CLI)": { "description": "PostgreSQL CLI (POSTGRESQL_CLI)", "value": { "name": "Run PostgreSQL queries", "type": "POSTGRESQL_CLI", "trigger_time": "ON_EVERY_EXECUTION", "version": "16", "shell": "BASH", "execute_commands": [ "psql -c '\\l'", "psql -f migrate.sql" ], "targets": [ { "identifier": "my_database", "name": "My PostgreSQL Database", "type": "POSTGRESQL", "scope": "ACTION", "host": "pg.example.com", "port": 5432, "database": "myapp", "auth": { "method": "PASSWORD", "username": "deploy_user", "password": "secured" } } ] } }, "Mongosh CLI (MONGOSH_CLI)": { "description": "Mongosh CLI (MONGOSH_CLI)", "value": { "name": "Run MongoDB queries", "type": "MONGOSH_CLI", "trigger_time": "ON_EVERY_EXECUTION", "version": "8.0", "shell": "BASH", "execute_commands": [ "mongosh --quiet \"$MONGOSH_URI\" --eval 'db.stats()'", "mongosh --quiet \"$MONGOSH_URI\" script.js" ], "targets": [ { "identifier": "my_mongo", "type": "MONGO", "scope": "ACTION", "host": "mongo.example.com", "database": "myapp", "auth_source": "admin", "auth": { "method": "PASSWORD", "username": "user", "password": "pass" } } ] } }, "MSSQL CLI (MSSQL_CLI)": { "description": "MSSQL CLI (MSSQL_CLI)", "value": { "name": "Run MSSQL queries", "type": "MSSQL_CLI", "trigger_time": "ON_EVERY_EXECUTION", "shell": "BASH", "execute_commands": [ "sqlcmd -Q 'SELECT @@VERSION'", "sqlcmd -i migrate.sql" ], "targets": [ { "identifier": "my_mssql_database", "name": "My MSSQL Database", "type": "MSSQL", "scope": "ACTION", "host": "mssql.example.com", "port": "1433", "database": "app", "auth": { "method": "PASSWORD", "username": "app_user", "password": "secured" } } ] } }, "GKE Run Helm (HELM)": { "description": "GKE Run Helm (HELM)", "value": { "name": "K8s Helm", "disabled": true, "type": "HELM", "trigger_time": "ON_EVERY_EXECUTION", "trigger_conditions": [ { "trigger_condition": "ON_CHANGE" }, { "trigger_condition": "HOUR", "trigger_hours": [ 8, 9, 10 ], "timezone": "Europe/Warsaw" } ], "targets": [ { "role_arn": "arn:aws:iam::123456789012:role/eks-cluster-service-role", "region": "eu-central-1", "identifier": "my_target_id", "name": "my-target", "integration": "hiqfilrcfx", "type": "EKS", "scope": "ACTION", "tags": [ "olive", "orange", "rabsperry" ], "cluster": "https://192.168.5.226:6443" } ], "helm_repository_integration": { "identifier": "aws" }, "helm_repository_region": "us-west-2", "execute_commands": [ "kubectl get namespaces -o=custom-columns=NAME:.metadata.name", "cat ~/.kube/config" ], "setup_commands": [ "helm plugin install https://github.com/hypnoglow/helm-s3.git --version 0.7.0", "helm plugin install https://github.com/hayorov/helm-gcs --version 0.2.1" ], "helm_version": "v3.10.2", "variables": [ { "key": "env_key", "value": "env_value", "type": "VAR", "settable": false, "run_only_settable": false, "encrypted": false, "description": "twcksymvsi" } ], "shell": "BASH", "kubectl_version": "latest", "timeout": 1800, "retry_interval": 60, "retry_count": 5, "ignore_errors": true, "current_revision": "21825f31ddce8a89b3ed9f4c92f038b339cde150", "loop": [ "env_key" ] } }, "ZIP (ZIP)": { "description": "ZIP (ZIP)", "value": { "name": "Zippy zip", "type": "ZIP", "trigger_time": "ON_EVERY_EXECUTION", "local_path": "/dir_to_zip", "destination": "artifact.zip", "deployment_excludes": [ "/tmp/", "*.log" ], "deployment_includes": [ "/assets/style", "/tmp/file.txt" ] } }, "Eslint (ESLINT) ⚠️ DEPRECATED": { "description": "Eslint (ESLINT) ⚠️ DEPRECATED", "value": { "name": "ESLint analyse", "type": "ESLINT", "trigger_time": "ON_EVERY_EXECUTION", "version": "9.4.0", "style": "airbnb", "fix": true, "quiet": true } }, "Sign Android Application (ANDROID_SIGN)": { "description": "Sign Android Application (ANDROID_SIGN)", "value": { "name": "Sign Android App", "type": "ANDROID_SIGN", "trigger_time": "ON_EVERY_EXECUTION", "local_path": "my-app-unsigned-aligned.apk", "output_dir": "out", "application_name": "my-app-release.apk", "key_path": "my-release-key.jks", "key_alias": "", "key_password": "${key_password}", "keystore_password": "${keystore_password}", "build_tool_version": "26.0.2" } }, "Sign Bundle (ANDROID_SIGN_BUNDLE)": { "description": "Sign Bundle (ANDROID_SIGN_BUNDLE)", "value": { "name": "Sign Android bundle", "type": "ANDROID_SIGN_BUNDLE", "trigger_time": "ON_EVERY_EXECUTION", "local_path": "app/build/outputs/bundle/release/app-release.aab", "output_dir": "/", "application_name": "app-release-signed.aab", "key_path": "my-release-key.jks", "key_alias": "", "key_password": "${key_password}", "keystore_password": "${keystore_password}" } }, "Publish Android Application (ANDROID_PUBLISH_APK)": { "description": "Publish Android Application (ANDROID_PUBLISH_APK)", "value": { "name": "Publish Android App", "type": "ANDROID_PUBLISH_APK", "trigger_time": "ON_EVERY_EXECUTION", "application_id": "com.mycompany.mylovelyapp", "track": "alpha", "user_fraction": 0.05, "mapping_path": "", "changes_path": "changes.xml", "supersede_versions": true, "draft": true, "variables": [ { "key": "apkPath", "value": "my-app-release9.apk" } ], "apk_files": [ { "apk_path": "$apkPath", "main_expansion_path": "ss", "patch_expansion_path": "" } ], "integration": { "identifier": "google-play" } } }, "Upload APK to Google Play (ANDROID_PLAY) ⚠️ DEPRECATED": { "description": "Upload APK to Google Play (ANDROID_PLAY) ⚠️ DEPRECATED", "value": { "name": "Upload APK to Google Play", "type": "ANDROID_PLAY", "trigger_time": "ON_EVERY_EXECUTION", "application_id": "com.mycompany.mylovelyapp", "track": "production", "user_fraction": 0.1, "mapping_path": "app/build/outputs/mapping/release/mapping.txt", "changes_path": "release-notes.xml", "supersede_versions": false, "draft": false, "changes_not_sent_for_review": false, "apk_files": [ { "apk_path": "app/build/outputs/apk/release/app-release.apk", "main_expansion_path": "", "patch_expansion_path": "" } ], "key_path": "google-play-key.json", "integration": { "identifier": "google-play" } } }, "Publish Android App Bundle (ANDROID_PUBLISH_APP_BUNDLE)": { "description": "Publish Android App Bundle (ANDROID_PUBLISH_APP_BUNDLE)", "value": { "name": "Publish Android App Bundle", "disabled": true, "type": "ANDROID_PUBLISH_APP_BUNDLE", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "euyxwcxbtr", "name": "slskopytko", "type": "GOOGLE_PLAY_STORE", "scope": "WORKSPACE" }, "application_id": "artifact-name", "variables": [ { "key": "env_key", "value": "env_value", "type": "VAR", "settable": false, "run_only_settable": false, "encrypted": false, "description": "popbtdrugc" } ], "track": "rollout", "user_fraction": 0.1, "changes_path": "/assets/Controller.php", "supersede_versions": true, "apk_files": [ { "apk_path": "bundle", "main_expansion_path": "main-file", "patch_expansion_path": "patch-file" } ], "draft": true, "timeout": 1800, "retry_interval": 60, "retry_count": 5, "ignore_errors": true, "current_revision": "21825f31ddce8a89b3ed9f4c92f038b339cde150", "loop": [ "env_key" ] } }, "Upload Bundle to Google Play (ANDROID_PLAY_BUNDLE) ⚠️ DEPRECATED": { "description": "Upload Bundle to Google Play (ANDROID_PLAY_BUNDLE) ⚠️ DEPRECATED", "value": { "name": "Upload Bundle to Google Play", "type": "ANDROID_PLAY_BUNDLE", "trigger_time": "ON_EVERY_EXECUTION", "application_id": "com.mycompany.mylovelyapp", "track": "internal", "user_fraction": 1, "changes_path": "release-notes.xml", "supersede_versions": true, "draft": true, "changes_not_sent_for_review": false, "apk_files": [ { "apk_path": "app/build/outputs/bundle/release/app-release.aab" } ], "key_path": "google-play-key.json", "integration": { "identifier": "google-play" } } }, "Firebase (FIREBASE)": { "description": "Firebase (FIREBASE)", "value": { "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": { "identifier": "firebase" } } }, "Netlify (NETLIFY)": { "description": "Netlify (NETLIFY)", "value": { "name": "Deploy to apk-42707", "type": "NETLIFY", "trigger_time": "ON_EVERY_EXECUTION", "shell": "SH", "site_id": "70225fg3-9sc1-17c6-98dc-ef367123f12d9", "setup_commands": [ "apt-get update && apt-get -y install git" ], "execute_commands": [ "netlify deploy --dir=${netlify_dir}" ], "variables": [ { "key": "netlify_dir", "value": "directory_name" } ], "integration": { "identifier": "netlify" } } }, "Lighthouse (LIGHTHOUSE)": { "description": "Lighthouse (LIGHTHOUSE)", "value": { "name": "Lighthouse", "type": "LIGHTHOUSE", "trigger_time": "ON_EVERY_EXECUTION", "device": "mobile", "website": "https://buddy.works", "performance": 50, "accessibility": 50, "best_practices": 50, "seo": 50 } }, "Replace (REPLACE)": { "description": "Replace (REPLACE)", "value": { "name": "Replace values", "type": "REPLACE", "trigger_time": "ON_EVERY_EXECUTION", "local_path": "/", "replacements": [ { "replace_from": "[ENV]", "replace_to": "stage" }, { "replace_from": "multiline", "replace_to": "Replace\nmultiline\nstring" } ] } }, "Gitcrypt unlock (GIT_CRYPT_UNLOCK)": { "description": "Gitcrypt unlock (GIT_CRYPT_UNLOCK)", "value": { "name": "Gitcrypt unlock", "type": "GIT_CRYPT_UNLOCK", "trigger_time": "ON_EVERY_EXECUTION", "keys": [ { "name": "default", "content": "secure!e5ToPs3ggT/W0sdRwV3Jn7qvJzS4Fl4D7I/BHY23P57EH04XExkZoYPjIC6/ETXnT86BbAOjwHFhuHtg3caXASCuAeD3cdSaQ8oJhBGii7MVXU9ErExHS9un0uJUHvLQo3JD6+sHf6QBYCJ3QFY/oNG+qL" } ] } }, "Gitcrypt lock (GIT_CRYPT_LOCK)": { "description": "Gitcrypt lock (GIT_CRYPT_LOCK)", "value": { "name": "Gitcrypt lock", "type": "GIT_CRYPT_LOCK", "trigger_time": "ON_EVERY_EXECUTION", "keys": [ { "name": "default", "content": "secure!e5ToPs3ggT/W0sdRwV3Jn7qvJzS4Fl4D7I/BHY23P57EH04XExkZoYPjIC6/ETXnT86BbAOjwHFhuHtg3caXASCuAeD3cdSaQ8oJhBGii7MVXU9ErExHS9un0uJUHvLQo3JD6+sHf6QBYCJ3QFY/oNG+qL" } ] } }, "Split Tests (SPLIT_TESTS)": { "description": "Split Tests (SPLIT_TESTS)", "value": { "name": "Split Tests", "type": "SPLIT_TESTS", "trigger_time": "ON_EVERY_EXECUTION", "source_path": "/tests/", "groups_count": 4, "files_order": "BY_FILE_SIZE" } }, "Compress images (IMAGE_COMPRESSION)": { "description": "Compress images (IMAGE_COMPRESSION)", "value": { "name": "Compress images", "type": "IMAGE_COMPRESSION", "trigger_time": "ON_EVERY_EXECUTION", "local_path": "/local", "destination": "/destination", "level": "1", "types": "jpg,png,gif,svg" } }, "Dockerfile Linter (DOCKERFILE_LINTER)": { "description": "Dockerfile Linter (DOCKERFILE_LINTER)", "value": { "name": "linter", "type": "DOCKERFILE_LINTER", "trigger_time": "ON_EVERY_EXECUTION", "local_path": "Dockerfile", "shell_type": "bash", "ignore_codes": "ER0012,ER0015,SC1017,SC2020", "ignores_path": "ignores.yaml" } }, "Download (DOWNLOAD)": { "description": "Download (DOWNLOAD)", "value": { "name": "Download files from FTP server", "type": "DOWNLOAD", "trigger_time": "ON_EVERY_EXECUTION", "source_path": "/source", "recursive": false, "targets": [ { "type": "FTP", "secure": false, "identifier": "ftp_target_1", "host": "192.0.2.1", "port": "21", "auth": { "username": "user", "password": "secure!gYTKjljwPt4nAffHn6mGEQ==.5rkCAHX55eiwOqJ73oGg6g==" }, "path": "/var/www" } ], "destination_path": "/assets", "overwrite": false } }, "Download S3 (DOWNLOAD_S3)": { "description": "Download S3 (DOWNLOAD_S3)", "value": { "name": "Download files from AWS S3/", "type": "DOWNLOAD_S3", "trigger_time": "ON_EVERY_EXECUTION", "bucket_name": "bucketname", "source_path": "source", "destination_path": "destination", "integration": { "identifier": "aws" }, "overwrite": true, "recursive": true, "download_excludes": [ "/tmp", "*.log" ], "download_includes": [ "/tmp/assets", "/tmp/styles" ] } }, "Download from Sandbox (DOWNLOAD_FROM_SANDBOX) ⚠️ DEPRECATED": { "description": "Download from Sandbox (DOWNLOAD_FROM_SANDBOX) ⚠️ DEPRECATED", "value": { "name": "Download Test Results", "type": "DOWNLOAD_FROM_SANDBOX", "trigger_time": "ON_EVERY_EXECUTION", "sandbox_id": "ghwmnj2az2k67", "sandbox_references": [ "BY_ID" ], "source_path": "/var/test-results", "destination_path": "/test-reports", "recursive": true, "overwrite": true, "user": "testrunner", "download_excludes": [ "*.tmp", "cache/*" ], "download_includes": [ "**/*.xml", "**/*.html" ] } }, "Download GCS (DOWNLOAD_GCS)": { "description": "Download GCS (DOWNLOAD_GCS)", "value": { "name": "Download files from GCS", "type": "DOWNLOAD_GCS", "trigger_time": "ON_EVERY_EXECUTION", "bucket_name": "bucketname", "source_path": "source", "destination_path": "destination", "integration": { "identifier": "gcp" }, "overwrite": true, "recursive": true, "download_excludes": [ "/tmp", "*.log" ], "download_includes": [ "/tmp/assets", "/tmp/styles" ], "application_name": "hello-world" } }, "Download Backblaze B2 (DOWNLOAD_BACKBLAZE_B2)": { "description": "Download Backblaze B2 (DOWNLOAD_BACKBLAZE_B2)", "value": { "name": "Download files from Backblaze B2/bucketname", "type": "DOWNLOAD_BACKBLAZE_B2", "trigger_time": "ON_EVERY_EXECUTION", "bucket_name": "bucketname", "source_path": "source", "destination_path": "destination", "integration": { "identifier": "backblaze" }, "region": "us-east-005", "overwrite": true, "recursive": true, "download_excludes": [ "/tmp", "*.log" ], "download_includes": [ "/tmp/assets", "/tmp/styles" ] } }, "Download Artifact (DOWNLOAD_ARTIFACT_VERSION)": { "description": "Download Artifact (DOWNLOAD_ARTIFACT_VERSION)", "value": { "name": "Download files from Artifact", "disabled": true, "type": "DOWNLOAD_ARTIFACT_VERSION", "trigger_time": "ON_EVERY_EXECUTION", "source_path": "target/path/on/server", "recursive": true, "version": "1.0.0", "destination_path": "/assets/", "overwrite": true, "variables": [ { "key": "env_key", "value": "env_value", "type": "VAR", "settable": false, "run_only_settable": false, "encrypted": false, "description": "nkrttlwhfx" } ], "timeout": 1800, "retry_interval": 60, "retry_count": 5, "ignore_errors": true, "download_excludes": [ "/ignorePath", "/ignore/path/2" ], "download_includes": [ "/excludePath", "/exclude/path/2" ], "current_revision": "21825f31ddce8a89b3ed9f4c92f038b339cde150", "artifact": "buddytests", "loop": [ "env_key" ] } }, "Create new sandbox (SANDBOX_CREATE)": { "description": "Create new sandbox (SANDBOX_CREATE)", "value": { "name": "Create sandbox", "disabled": true, "type": "SANDBOX_CREATE", "trigger_time": "ON_EVERY_EXECUTION", "timeout": 1800, "retry_interval": 60, "retry_count": 5, "ignore_errors": true, "current_revision": "21825f31ddce8a89b3ed9f4c92f038b339cde150", "from": "SCRATCH", "update_if_exists": true, "start": false, "spec": { "name": "Running", "identifier": "running", "os": "ubuntu:24.04", "resources": "3x6", "first_boot_commands": "apt-get update\napt-get install -y nginx", "tags": [ "azure", "purple" ], "apps": [ "nginx -t" ], "app_dir": "/var/www/html", "endpoints": [ { "name": "buddy-graigmaribelesposito-dev-tcp", "endpoint": "localhost:22", "domain": "agent-dev.net", "subdomain": null, "region": "EU", "type": "TCP", "timeout": 60, "whitelist": [ "12.34.56.78" ] } ] }, "loop": [ "env_key" ] } }, "Clone Sandbox (SANDBOX_CREATE_FROM_SANDBOX)": { "description": "Clone Sandbox (SANDBOX_CREATE_FROM_SANDBOX)", "value": { "name": "staging-clone-001", "type": "SANDBOX_CREATE_FROM_SANDBOX", "trigger_time": "ON_EVERY_EXECUTION", "sandbox_name": "staging-clone-001", "referenced_sandbox_name": "prod-sandbox-001", "sandbox_distribution": "ubuntu:22.04", "resources": "2x4", "return_existing": false, "tags": [ "staging", "clone" ] } }, "Create Sandbox from Snapshot (SANDBOX_CREATE_FROM_SNAPSHOT)": { "description": "Create Sandbox from Snapshot (SANDBOX_CREATE_FROM_SNAPSHOT)", "value": { "name": "restored-environment", "type": "SANDBOX_CREATE_FROM_SNAPSHOT", "trigger_time": "ON_EVERY_EXECUTION", "sandbox_name": "restored-environment", "snapshot_id": "snapshot-20250107", "sandbox_distribution": "ubuntu:22.04", "resources": "4x8", "return_existing": false, "tags": [ "restored", "backup" ] } }, "Manage sandbox (SANDBOX_MANAGE)": { "description": "Manage sandbox (SANDBOX_MANAGE)", "value": { "name": "Start sandbox app", "type": "SANDBOX_MANAGE", "trigger_time": "ON_EVERY_EXECUTION", "disabled": false, "operation": "APP_START", "targets": [ { "identifier": "create-sb", "scope": "ANY", "type": "MATCH" } ], "ignore_errors": false, "run_next_parallel": false } }, "Start Sandbox App (SANDBOX_APPLICATION_START)": { "description": "Start Sandbox App (SANDBOX_APPLICATION_START)", "value": { "name": "Start Web Server", "type": "SANDBOX_APPLICATION_START", "trigger_time": "ON_EVERY_EXECUTION", "sandbox_id": "ghwmnj2az2k67", "sandbox_references": [ "BY_ID" ] } }, "Stop Sandbox App (SANDBOX_APPLICATION_STOP)": { "description": "Stop Sandbox App (SANDBOX_APPLICATION_STOP)", "value": { "name": "Stop Web Server", "type": "SANDBOX_APPLICATION_STOP", "trigger_time": "ON_EVERY_EXECUTION", "sandbox_id": "ghwmnj2az2k67", "sandbox_references": [ "BY_ID" ] } }, "Start Sandbox (SANDBOX_START) ⚠️ DEPRECATED": { "description": "Start Sandbox (SANDBOX_START) ⚠️ DEPRECATED", "value": { "name": "Start Development Sandbox", "type": "SANDBOX_START", "trigger_time": "ON_EVERY_EXECUTION", "sandbox_id": "ghwmnj2az2k67", "sandbox_references": [ "BY_ID" ], "tags": [ "development" ] } }, "Stop Sandbox (SANDBOX_STOP) ⚠️ DEPRECATED": { "description": "Stop Sandbox (SANDBOX_STOP) ⚠️ DEPRECATED", "value": { "name": "Stop Development Sandbox", "type": "SANDBOX_STOP", "trigger_time": "ON_EVERY_EXECUTION", "sandbox_id": "ghwmnj2az2k67", "sandbox_references": [ "BY_ID" ], "tags": [ "development" ] } }, "Create New Sandbox (SANDBOX_CREATE_NEW) ⚠️ DEPRECATED": { "description": "Create New Sandbox (SANDBOX_CREATE_NEW) ⚠️ DEPRECATED", "value": { "name": "Create Test Environment", "type": "SANDBOX_CREATE_NEW", "trigger_time": "ON_EVERY_EXECUTION", "sandbox_name": "test-env-pr-456", "sandbox_distribution": "ubuntu:22.04", "resources": "2x4", "return_existing": false, "sandbox_project_id": 789, "tags": [ "test", "pr-456" ] } }, "Create Sandbox Snapshot (SANDBOX_SNAPSHOT) ⚠️ DEPRECATED": { "description": "Create Sandbox Snapshot (SANDBOX_SNAPSHOT) ⚠️ DEPRECATED", "value": { "name": "Backup Before Deployment", "type": "SANDBOX_SNAPSHOT", "trigger_time": "ON_EVERY_EXECUTION", "sandbox_id": "ghwmnj2az2k67", "sandbox_references": [ "BY_ID" ], "snapshot_name": "pre-deployment-v2.5.0" } }, "Delete Sandbox (SANDBOX_DELETE) ⚠️ DEPRECATED": { "description": "Delete Sandbox (SANDBOX_DELETE) ⚠️ DEPRECATED", "value": { "name": "Cleanup Test Environment", "type": "SANDBOX_DELETE", "trigger_time": "ON_EVERY_EXECUTION", "sandbox_id": "test-env-pr-456", "sandbox_references": [ "BY_ID" ] } }, "Validate Website Links (LINK_VALIDATOR) ⚠️ DEPRECATED": { "description": "Validate Website Links (LINK_VALIDATOR) ⚠️ DEPRECATED", "value": { "name": "Check Website Links", "type": "LINK_VALIDATOR", "trigger_time": "ON_EVERY_EXECUTION", "website": "https://www.example.com", "depth": 3, "ignored_prefixes": [ "https://external-tracker.com", "https://analytics.google.com", "mailto:" ], "ignore_errors": false, "timeout": 600 } }, "Link Checker (LINK_CHECKER)": { "description": "Link Checker (LINK_CHECKER)", "value": { "name": "Link checker", "type": "LINK_CHECKER", "trigger_time": "ON_EVERY_EXECUTION", "ba_username": "basicAuthUsername", "ba_password": "secure!ucaApNnkABxsQuyAQJ4sXQ==.QPJaybamhxXg2j9ICwoSKw==", "html_form_auth_username": "htmlFormAuthUsername", "html_form_auth_password": "secure!ucaApNnkABxsQuyAQJ4sXQ==.QPJaybamhxXg2j9ICwoSKw==", "html_form_auth_username_input_name": "htmlFormAuthUsernameInput", "html_form_auth_password_input_name": "htmlFormAuthPasswordInput", "html_form_auth_url": "https://linktocheck.com", "depth": 1, "scan_url": "https://linktocheck.com", "cookies": [ { "name": "header", "value": "value" } ], "threads": 5, "connection_timeout": 11, "requests_per_host": 5, "respect_robot_exclusions": false, "check_ssl_certificate": true, "internal_links": "Scan_url/*", "check_external_links": true, "ignore_urls": [ "https://example.com/.*" ], "no_follow_urls": [ "https://example.com/.*" ], "warning_regex": "(This page has moved|Oracle Application error)" } }, "Azure CLI (AZURE_CLI)": { "description": "Azure CLI (AZURE_CLI)", "value": { "name": "Azure Cli", "type": "AZURE_CLI", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "azure" }, "setup_commands": [ "apt-get update && apt-get -y install git" ], "execute_commands": [ "az webapp list" ], "shell": "SH" } }, "Theme Kit CLI (SHOPIFY_THEMEKIT_CLI)": { "description": "Theme Kit CLI (SHOPIFY_THEMEKIT_CLI)", "value": { "name": "Shopify theme", "type": "SHOPIFY_THEMEKIT_CLI", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "shopify" }, "setup_commands": [ "apt-get update && apt-get -y install git" ], "execute_commands": [ "theme deploy" ], "shell": "SH" } }, "Shopify CLI (SHOPIFY_CLI)": { "description": "Shopify CLI (SHOPIFY_CLI)", "value": { "name": "Shopify", "type": "SHOPIFY_CLI", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "shopify" }, "setup_commands": [ "apt-get update && apt-get -y install git" ], "execute_commands": [ "shopify theme push --theme your_theme_name --store=your_store_url" ], "shell": "SH" } }, "SSL verify (SSL_VERIFY)": { "description": "SSL verify (SSL_VERIFY)", "value": { "name": "SSL VERIFY", "port": "443", "type": "SSL_VERIFY", "trigger_time": "ON_EVERY_EXECUTION", "website": "buddy.works", "valid_for_days": 31 } }, "GitHub Release (GIT_HUB_RELEASE)": { "description": "GitHub Release (GIT_HUB_RELEASE)", "value": { "name": "Make GitHub Release", "type": "GIT_HUB_RELEASE", "trigger_time": "ON_EVERY_EXECUTION", "draft": true, "tag_name": "$BUDDY_RUN_ID", "target_commitish": "$BUDDY_RUN_COMMIT", "release_name": "app release", "body": "body", "prerelease": true, "zip_assets": false, "external_project_id": "buddy/repo-tests", "organization": "buddy", "assets": [ { "source_path": "assets", "label": "labelName" } ], "integration": { "identifier": "github" } } }, "Windows (NATIVE_BUILD_WINDOWS)": { "description": "Windows (NATIVE_BUILD_WINDOWS)", "value": { "name": "Execute: msbuild", "type": "NATIVE_BUILD_WINDOWS", "trigger_time": "ON_EVERY_EXECUTION", "working_directory": "c:\\windows", "commands": [ "nuget restore", "msbuild" ], "execute_every_command": true, "distribution": "AMI", "ami": { "id": "ami-00bf6b81ba0081ada", "password": "pass-to-admin" }, "sync_paths": [ { "pipeline_path": "/", "vm_path": "c:\\buddy", "direction": "PIPELINE_TO_VM" }, { "pipeline_path": "/", "vm_path": "c:\\buddy", "direction": "VM_TO_PIPELINE" } ] } }, "Xcode (NATIVE_BUILD_MAC)": { "description": "Xcode (NATIVE_BUILD_MAC)", "value": { "name": "Build application", "type": "NATIVE_BUILD_MAC", "trigger_time": "ON_EVERY_EXECUTION", "working_directory": "/Users/buddy/build", "commands": [ "ls" ], "execute_every_command": true, "sync_paths": [ { "pipeline_path": "/", "vm_path": "/Users/buddy/build", "direction": "PIPELINE_TO_VM" }, { "pipeline_path": "/", "vm_path": "/Users/buddy/build", "direction": "VM_TO_PIPELINE" } ], "xcode_version": "13", "pre_start_simulators": [ "iPhone 13 Pro Max" ], "certificates": [ "myCert" ], "provision_profiles": [ "myProfile" ] } }, "MacOS VM (NATIVE_BUILD_MAC_VM)": { "description": "MacOS VM (NATIVE_BUILD_MAC_VM)", "value": { "name": "Build iOS App on macOS VM", "type": "NATIVE_BUILD_MAC_VM", "trigger_time": "ON_EVERY_EXECUTION", "working_directory": "/", "commands": [ "xcodebuild clean", "xcodebuild -workspace MyApp.xcworkspace -scheme MyApp -configuration Release archive -archivePath ./build/MyApp.xcarchive" ], "execute_every_command": true, "xcode_version": "15.2", "node_version": "20.10.0", "shell": "BASH", "sync_paths": [ { "pipeline_path": "/workspace", "vm_path": "/Users/builder/project", "direction": "PIPELINE_TO_VM", "excludes": "*.log", "includes": "" }, { "pipeline_path": "/artifacts", "vm_path": "/Users/builder/project/build", "direction": "VM_TO_PIPELINE", "excludes": "", "includes": "*.ipa" } ], "certificates": [ "$IOS_DISTRIBUTION_CERT" ], "provision_profiles": [ "$IOS_PROVISIONING_PROFILE" ] } }, "Build a React Native App (NATIVE_BUILD_MAC_REACT)": { "description": "Build a React Native App (NATIVE_BUILD_MAC_REACT)", "value": { "name": "Build application", "type": "NATIVE_BUILD_MAC_REACT", "trigger_time": "ON_EVERY_EXECUTION", "working_directory": "/Users/buddy/build", "commands": [ "ls" ], "execute_every_command": true, "sync_paths": [ { "pipeline_path": "/", "vm_path": "/Users/buddy/build", "direction": "PIPELINE_TO_VM" }, { "pipeline_path": "/", "vm_path": "/Users/buddy/build", "direction": "VM_TO_PIPELINE" } ], "node_version": "14", "xcode_version": "13", "pre_start_simulators": [ "iPhone 13 Pro Max" ], "certificates": [ "myCert" ], "provision_profiles": [ "myProfile" ] } }, "Build a Cordova App (NATIVE_BUILD_MAC_CORDOVA)": { "description": "Build a Cordova App (NATIVE_BUILD_MAC_CORDOVA)", "value": { "name": "Build application", "type": "NATIVE_BUILD_MAC_CORDOVA", "trigger_time": "ON_EVERY_EXECUTION", "working_directory": "/Users/buddy/build", "commands": [ "cordova build ios" ], "execute_every_command": true, "sync_paths": [ { "pipeline_path": "/", "vm_path": "/Users/buddy/build", "direction": "PIPELINE_TO_VM" }, { "pipeline_path": "/", "vm_path": "/Users/buddy/build", "direction": "VM_TO_PIPELINE" } ], "node_version": "14", "xcode_version": "13", "pre_start_simulators": [ "iPhone 13 Pro Max" ], "certificates": [ "myCert" ], "provision_profiles": [ "myProfile" ] } }, "Build a Fastlane App (NATIVE_BUILD_MAC_FASTLANE)": { "description": "Build a Fastlane App (NATIVE_BUILD_MAC_FASTLANE)", "value": { "name": "Build application", "type": "NATIVE_BUILD_MAC_FASTLANE", "trigger_time": "ON_EVERY_EXECUTION", "working_directory": "/Users/buddy/build", "commands": [ "fastlane snapshot" ], "execute_every_command": true, "sync_paths": [ { "pipeline_path": "/", "vm_path": "/Users/buddy/build", "direction": "PIPELINE_TO_VM" }, { "pipeline_path": "/", "vm_path": "/Users/buddy/build", "direction": "VM_TO_PIPELINE" } ], "node_version": "14", "xcode_version": "13", "pre_start_simulators": [ "iPhone 13 Pro Max" ], "certificates": [ "myCert" ], "provision_profiles": [ "myProfile" ] } }, "Build a Flutter App (NATIVE_BUILD_MAC_FLUTTER)": { "description": "Build a Flutter App (NATIVE_BUILD_MAC_FLUTTER)", "value": { "name": "Build application", "type": "NATIVE_BUILD_MAC_FLUTTER", "trigger_time": "ON_EVERY_EXECUTION", "working_directory": "/Users/buddy/build", "commands": [ "flutter build ios --release" ], "execute_every_command": true, "sync_paths": [ { "pipeline_path": "/", "vm_path": "/Users/buddy/build", "direction": "PIPELINE_TO_VM" }, { "pipeline_path": "/", "vm_path": "/Users/buddy/build", "direction": "VM_TO_PIPELINE" } ], "node_version": "14", "xcode_version": "13", "pre_start_simulators": [ "iPhone 13 Pro Max" ], "certificates": [ "myCert" ], "provision_profiles": [ "myProfile" ] } }, "Code sign and export an iOS app (NATIVE_BUILD_MAC_SIGN)": { "description": "Code sign and export an iOS app (NATIVE_BUILD_MAC_SIGN)", "value": { "name": "Sign and export", "type": "NATIVE_BUILD_MAC_SIGN", "trigger_time": "ON_EVERY_EXECUTION", "export_location": "/", "distribution_method": "APP_STORE", "property_list_source": "ACTION", "property_list": "list", "certificates": [ "myCert" ], "provision_profiles": [ "myProvisionProfile" ] } }, "Deploy to App Store Connect (NATIVE_BUILD_MAC_DEPLOY)": { "description": "Deploy to App Store Connect (NATIVE_BUILD_MAC_DEPLOY)", "value": { "name": "Deploy to App Store Connect", "type": "NATIVE_BUILD_MAC_DEPLOY", "trigger_time": "ON_EVERY_EXECUTION", "archive_location": "$BUDDY_SIGNED_IPA_PATH", "validate_before_upload": true, "submit_for_review": true, "skip_metadata": true, "skip_app_version_update": true, "skip_screenshots": true, "integration": { "identifier": "appstore-connect" } } }, "Docker CLI (NATIVE_BUILD_DOCKER_CLI)": { "description": "Docker CLI (NATIVE_BUILD_DOCKER_CLI)", "value": { "name": "Execute: docker --version", "type": "NATIVE_BUILD_DOCKER_CLI", "trigger_time": "ON_EVERY_EXECUTION", "working_directory": "/home/ubuntu/build", "commands": [ "docker --version" ], "execute_every_command": true, "sync_paths": [ { "pipeline_path": "/", "vm_path": "/home/ubuntu/build", "direction": "PIPELINE_TO_VM", "excludes": "/.git" }, { "pipeline_path": "/", "vm_path": "/home/ubuntu/build", "direction": "VM_TO_PIPELINE", "excludes": "" } ], "vm_from_prev_action": true, "vm_action_name": "Build action" } }, "Linux (NATIVE_BUILD_LINUX)": { "description": "Linux (NATIVE_BUILD_LINUX)", "value": { "name": "Build application", "type": "NATIVE_BUILD_LINUX", "trigger_time": "ON_EVERY_EXECUTION", "working_directory": "/home/ubuntu/build", "commands": [ "ls -al" ], "distribution": "AMI", "ami": { "id": "ami-00bf6b81ba0081ada", "user": "ubuntu", "port": "22" }, "sync_paths": [ { "pipeline_path": "/", "vm_path": "/home/ubuntu/build", "direction": "PIPELINE_TO_VM", "excludes": "/.git" }, { "pipeline_path": "/", "vm_path": "/home/ubuntu/build", "direction": "VM_TO_PIPELINE", "excludes": "" } ] } }, "DigitalOcean CLI (DOCTL)": { "description": "DigitalOcean CLI (DOCTL)", "value": { "name": "Execute: doctl account get", "type": "DOCTL", "trigger_time": "ON_EVERY_EXECUTION", "execute_commands": [ "doctl account get" ], "shell": "SH", "integration": { "identifier": "digitalocean" } } }, "Clear Cache (CLEAR_CACHE)": { "description": "Clear Cache (CLEAR_CACHE)", "value": { "name": "Clear cache", "type": "CLEAR_CACHE", "trigger_time": "ON_EVERY_EXECUTION", "cache_types": [ "DOCKER", "FILE_SYSTEM", "SERVICES", "ADDITIONAL" ] } }, "Fastlane for Android (FASTLANE_ANDROID)": { "description": "Fastlane for Android (FASTLANE_ANDROID)", "value": { "name": "Build Android with Fastlane", "type": "FASTLANE_ANDROID", "trigger_time": "ON_EVERY_EXECUTION", "build_tool_version": "34.0.0", "shell": "BASH", "setup_commands": [ "bundle install", "fastlane update_plugins" ], "execute_commands": [ "fastlane android beta" ], "execute_every_command": true, "variables": [ { "key": "ANDROID_HOME", "value": "/opt/android-sdk" } ] } }, "GitHub CLI (GIT_HUB_CLI)": { "description": "GitHub CLI (GIT_HUB_CLI)", "value": { "name": "Run GitHub CLI command", "type": "GIT_HUB_CLI", "trigger_time": "ON_EVERY_EXECUTION", "setup_commands": [ "apt-get update && apt-get -y install git" ], "execute_commands": [ "gh repo list" ], "shell": "BASH", "variables": [ { "key": "command", "value": "list-functions" } ], "integration": { "identifier": "github" } } }, "GitLab CLI (GIT_LAB_CLI)": { "description": "GitLab CLI (GIT_LAB_CLI)", "value": { "name": "Run GitLab CLI command", "type": "GIT_LAB_CLI", "trigger_time": "ON_EVERY_EXECUTION", "setup_commands": [ "apt-get update && apt-get -y install git" ], "execute_commands": [ "glab auth status" ], "shell": "BASH", "integration": { "identifier": "gitlab" } } }, "Generate variables (INTEGRATION_VARIABLES)": { "description": "Generate variables (INTEGRATION_VARIABLES)", "value": { "name": "Generate variables from an integration", "type": "INTEGRATION_VARIABLES", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "sample-integration" } } }, "Jira build notification (JIRA_BUILD)": { "description": "Jira build notification (JIRA_BUILD)", "value": { "name": "Send Jira build notification", "type": "JIRA_BUILD", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "jira-integration" }, "issue_key": "PROJ-123", "display_name": "Build #$BUDDY_EXECUTION_ID", "description": "Build completed for commit $BUDDY_EXECUTION_REVISION", "state": "successful" } }, "Jira deployment notification (JIRA_DEPLOYMENT)": { "description": "Jira deployment notification (JIRA_DEPLOYMENT)", "value": { "name": "Send Jira deployment notification", "type": "JIRA_DEPLOYMENT", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "jira-integration" }, "issue_key": "PROJ-123", "display_name": "Deploy to production #$BUDDY_EXECUTION_ID", "description": "Deployment completed successfully", "state": "successful", "environment_id": "prod-env-123", "environment_name": "Production Environment", "environment_type": "production" } }, "AWS CodePipeline (CODE_PIPELINE)": { "description": "AWS CodePipeline (CODE_PIPELINE)", "value": { "name": "Trigger AWS CodePipeline", "type": "CODE_PIPELINE", "region": "us-west-2", "code_pipeline_name": "my_codepipeline_name", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "aws" } } }, "AWS CDK CLI (AWS_CDK_CLI)": { "description": "AWS CDK CLI (AWS_CDK_CLI)", "value": { "name": "Run AWS CDK commands", "type": "AWS_CDK_CLI", "trigger_time": "ON_EVERY_EXECUTION", "setup_commands": [ "apt-get update && apt-get -y install git" ], "execute_commands": [ "cdk --version" ], "shell": "SH", "integration": { "identifier": "aws" }, "region": "us-west-2" } }, "Ghost Inspector CLI (GHOST_INSPECTOR_CLI)": { "description": "Ghost Inspector CLI (GHOST_INSPECTOR_CLI)", "value": { "name": "Run Ghost Inspector CLI", "type": "GHOST_INSPECTOR_CLI", "trigger_time": "ON_EVERY_EXECUTION", "setup_commands": [ "apt-get update && apt-get -y install git" ], "execute_commands": [ "ghost-inspector suite list-tests " ], "shell": "SH", "integration": { "identifier": "ghost-inspector" } } }, "Terraform CLI (TERRAFORM)": { "description": "Terraform CLI (TERRAFORM)", "value": { "name": "Run Terraform commands", "type": "TERRAFORM", "trigger_time": "ON_EVERY_EXECUTION", "setup_commands": [ "apt-get update && apt-get -y install git" ], "execute_commands": [ "terraform init -input=false", "terraform plan -input=false", "#terraform apply -auto-approve -input=false" ], "shell": "SH", "integration": { "identifier": "terraform-registry" }, "version": "latest" } }, "Snyk (SNYK_CLI)": { "description": "Snyk (SNYK_CLI)", "value": { "name": "Run Snyk CLI commands", "type": "SNYK_CLI", "trigger_time": "ON_EVERY_EXECUTION", "setup_commands": [ "apt-get update && apt-get -y install git" ], "execute_commands": [ "snyk test" ], "shell": "SH", "integration": { "identifier": "snyk" }, "version": "node-16" } }, "StackHawk CLI (STACK_HAWK_CLI)": { "description": "StackHawk CLI (STACK_HAWK_CLI)", "value": { "name": "Run StackHawk CLI commands", "type": "STACK_HAWK_CLI", "trigger_time": "ON_EVERY_EXECUTION", "setup_commands": [ "apt-get update && apt-get -y install git" ], "execute_commands": [ "hawk validate config stackhawk.yml", "hawk scan --repo-dir=." ], "shell": "SH", "integration": { "identifier": "stackhawk" } } }, "JMeter CLI (JMETER_CLI)": { "description": "JMeter CLI (JMETER_CLI)", "value": { "name": "Run JMeter CLI commands", "type": "JMETER_CLI", "trigger_time": "ON_EVERY_EXECUTION", "setup_commands": [ "apt-get update && apt-get -y install git" ], "execute_commands": [ "jmeter -n –t test.jmx -l testresults.jtl" ], "shell": "SH" } }, "Trivy CLI (TRIVY_CLI)": { "description": "Trivy CLI (TRIVY_CLI)", "value": { "name": "Run Trivy CLI commands", "type": "TRIVY_CLI", "trigger_time": "ON_EVERY_EXECUTION", "version": "0.69.3", "execute_commands": [ "trivy fs --severity HIGH,CRITICAL ." ], "shell": "SH" } }, "Blackfire PHP (BLACKFIRE_PHP)": { "description": "Blackfire PHP (BLACKFIRE_PHP)", "value": { "name": "Run Blackfire PHP CLI", "type": "BLACKFIRE_PHP", "trigger_time": "ON_EVERY_EXECUTION", "version": "latest", "integration": { "identifier": "blackfire" }, "execute_commands": [ "composer install", "blackfire run bin/console" ], "setup_commands": [ "apt-get update && apt-get -y install git" ], "shell": "BASH" } }, "Blackfire Python Profiling (BLACKFIRE_PYTHON)": { "description": "Blackfire Python Profiling (BLACKFIRE_PYTHON)", "value": { "name": "Profile Python Application", "type": "BLACKFIRE_PYTHON", "trigger_time": "ON_EVERY_EXECUTION", "version": "1.8.2", "shell": "BASH", "setup_commands": [ "pip install blackfire" ], "execute_commands": [ "blackfire run python manage.py test", "blackfire curl https://staging.example.com/api/products" ], "execute_every_command": true, "variables": [ { "key": "BLACKFIRE_SERVER_ID", "value": "$BLACKFIRE_SERVER_ID", "encrypted": true }, { "key": "BLACKFIRE_SERVER_TOKEN", "value": "$BLACKFIRE_SERVER_TOKEN", "encrypted": true } ] } }, "Blackfire GO (BLACKFIRE_GO)": { "description": "Blackfire GO (BLACKFIRE_GO)", "value": { "name": "Run Blackfire Go CLI", "type": "BLACKFIRE_GO", "trigger_time": "ON_EVERY_EXECUTION", "version": "latest", "integration": { "identifier": "blackfire" }, "execute_commands": [ "blackfire run ./go_bin" ], "setup_commands": [ "apt-get update && apt-get -y install git" ], "shell": "BASH" } }, "Docker (DOCKER)": { "description": "Docker (DOCKER)", "value": { "name": "Run docker commands", "type": "DOCKER", "trigger_time": "ON_EVERY_EXECUTION", "execute_commands": [ "docker --version" ], "setup_commands": [ "apt-get update -y", "apt-get install -y wget" ], "shell": "SH", "region": "us-east-1", "integration": { "identifier": "docker-registry" } } }, "Configure Pipeline Settings (PIPELINE_SETTINGS)": { "description": "Configure Pipeline Settings (PIPELINE_SETTINGS)", "value": { "name": "Update Pipeline Schedule", "type": "PIPELINE_SETTINGS", "trigger_time": "ON_EVERY_EXECUTION", "cron": "0 2 * * 1-5", "target_pipeline": { "id": 123, "identifier": "nightly-build", "project": { "name": "my-project" } } } }, "New Relic CLI (NEW_RELIC_CLI)": { "description": "New Relic CLI (NEW_RELIC_CLI)", "value": { "name": "Run New Relic CLI", "type": "NEW_RELIC_CLI", "trigger_time": "ON_EVERY_EXECUTION", "setup_commands": [ "apt-get update && apt-get -y install git" ], "execute_commands": [ "newrelic entity deployment create" ], "shell": "SH", "integration": { "identifier": "newrelic" } } }, "Contentful CLI (CONTENTFUL_CLI)": { "description": "Contentful CLI (CONTENTFUL_CLI)", "value": { "name": "Run Contentful CLI", "type": "CONTENTFUL_CLI", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "contentful", "type": "CONTENTFUL", "scope": "WORKSPACE" }, "environment": "master", "execute_commands": [ "contentful space list" ], "space": "Blank" } }, "Npm (NPM_PUBLISH)": { "description": "Npm (NPM_PUBLISH)", "value": { "name": "Run NPM publish", "type": "NPM_PUBLISH", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "github" }, "npm_registry": "GIT_HUB", "source_path": "/", "ignore_scripts": "true", "access": "PUBLIC", "tag": "latest" } }, "WP CLI (WP_CLI)": { "description": "WP CLI (WP_CLI)", "value": { "name": "Run WordPress CLI", "type": "WP_CLI", "trigger_time": "ON_EVERY_EXECUTION", "setup_commands": [ "apt-get update && apt-get -y install git" ], "execute_commands": [ "wp admin" ], "shell": "SH", "version": "cli", "config": "@staging:\n ssh: wpcli@staging.wp-cli.org" } }, "Tag Docker Image (PROMOTE_IMAGE)": { "description": "Tag Docker Image (PROMOTE_IMAGE)", "value": { "name": "Promote to production tag", "type": "PROMOTE_IMAGE", "trigger_time": "ON_EVERY_EXECUTION", "same_location": true, "src": { "docker_registry": "DOCKER_HUB", "image": "mycompany/myapp:latest", "integration": "docker_hub_integration" }, "dest": { "docker_registry": "GOOGLE_ARTIFACT_REGISTRY", "registry": "us-central1-docker.pkg.dev", "image": "my-gcp-project/my-repo/myapp:production", "integration": "google_service_account" } } }, "Git Merge (GIT_MERGE)": { "description": "Git Merge (GIT_MERGE)", "value": { "name": "Merge develop into main", "type": "GIT_MERGE", "trigger_time": "ON_EVERY_EXECUTION", "branch": "develop", "conflict_strategy": "FAIL", "dry_run": false, "no_fast_forward": true } }, "Crawl (CRAWL)": { "description": "Crawl (CRAWL)", "value": { "name": "Crawl", "type": "CRAWL", "trigger_time": "ON_EVERY_EXECUTION", "crawl_suite": "my-crawl-suite", "url": "https://example.com", "follow": true, "respect_robots": true, "outputs": [ { "type": "PNG", "quality": 90, "full_page": true } ], "browsers": [ "chromium" ], "color_scheme": "dark", "cookies": [ "session=abc123" ], "headers": [ "Authorization: Bearer token" ], "delays": [ "1000" ], "wait_for": [ "#main-content" ], "local_storage": [ "key=value" ], "output_directory": "/crawl-output" } }, "Claude Code (CLAUDE_CODE)": { "description": "Claude Code (CLAUDE_CODE)", "value": { "name": "Claude Code", "type": "CLAUDE_CODE", "trigger_time": "ON_EVERY_EXECUTION", "prompts": [ { "type": "INLINE", "value": "Review the code changes and suggest improvements" } ], "model": "sonnet", "settings": { "type": "INLINE", "value": "{\"max_turns\": 10}" }, "claude_args": "--max-turns 5", "integration": { "hash_id": "my_anthropic_integration" }, "dangerously_skip_permissions": true } } } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionResponse" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/pipelines/791/actions/1233", "html_url": "https://app.buddy.works/my-workspace/my-project/pipelines/pipeline/791/action/1233/edit", "id": 1233, "name": "mvn artifact", "type": "BUILD", "current_revision": "58e239079a2161fec0ba96ed166557157ad3dd79", "trigger_time": "ON_EVERY_EXECUTION", "run_next": "WAIT_ON_SUCCESS", "disabled": false, "ignore_errors": false, "pipeline": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/pipelines/791", "html_url": "https://app.buddy.works/my-workspace/my-project/pipelines/pipeline/791", "id": 791, "identifier": "build", "name": "build", "definition_source": "LOCAL", "git_config_ref": "NONE", "refs": [ "refs/heads/master" ], "events": [ { "type": "WEBHOOK" } ], "priority": "NORMAL", "disabled": false, "last_execution_status": "SUCCESSFUL", "last_execution_revision": "58e239079a2161fec0ba96ed166557157ad3dd79", "always_from_scratch": false, "ignore_fail_on_project_status": false, "strict_context": false, "no_skip_to_most_recent": false, "terminate_stale_runs": false, "auto_clear_cache": false, "fetch_all_refs": false, "fail_on_prepare_env_warning": true, "concurrent_pipeline_runs": false, "do_not_create_commit_status": false, "stale": false, "waiting_for_push": false, "resources": "DEFAULT", "git_changeset_base": "LATEST_RUN", "filesystem_changeset_base": "DATE_MODIFIED", "cpu": "X64", "description_required": false }, "loop": [], "docker_image_name": "library/maven", "docker_image_tag": "3.9.9", "execute_commands": [ "mvn artifact" ], "mount_filesystem_disable": false, "volume_mappings": [ "/:/buddy/my-project" ], "cached_dirs": [ "/root/.m2/repository" ], "shell": "BASH", "region": "", "image_location": "PUBLIC_REGISTRY", "docker_registry": "DOCKER_HUB", "execute_every_command": false, "ignore_image_pull_failures": false, "cache_base_image": true, "reset_entrypoint": false, "vt_suite": "" } } } } }, "security": [ { "oauth2": [ "EXECUTION_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/pipelines/{pipeline_id}/actions/{id}": { "get": { "tags": [ "Action API" ], "summary": "Returns details of a single action", "operationId": "getAction", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "pipeline_id", "in": "path", "description": "The ID of the pipeline", "required": true, "schema": { "type": "integer", "format": "int32", "example": 123 } }, { "name": "id", "in": "path", "description": "The ID of the action", "required": true, "schema": { "type": "integer", "format": "int32", "example": 456 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionResponse" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/pipelines/791/actions/1233", "html_url": "https://app.buddy.works/my-workspace/my-project/pipelines/pipeline/791/action/1233/edit", "id": 1233, "name": "mvn artifact", "type": "BUILD", "current_revision": "58e239079a2161fec0ba96ed166557157ad3dd79", "trigger_time": "ON_EVERY_EXECUTION", "run_next": "WAIT_ON_SUCCESS", "disabled": false, "ignore_errors": false, "pipeline": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/pipelines/791", "html_url": "https://app.buddy.works/my-workspace/my-project/pipelines/pipeline/791", "id": 791, "identifier": "build", "name": "build", "definition_source": "LOCAL", "git_config_ref": "NONE", "refs": [ "refs/heads/master" ], "events": [ { "type": "WEBHOOK" } ], "priority": "NORMAL", "disabled": false, "last_execution_status": "SUCCESSFUL", "last_execution_revision": "58e239079a2161fec0ba96ed166557157ad3dd79", "always_from_scratch": false, "ignore_fail_on_project_status": false, "strict_context": false, "no_skip_to_most_recent": false, "terminate_stale_runs": false, "auto_clear_cache": false, "fetch_all_refs": false, "fail_on_prepare_env_warning": true, "concurrent_pipeline_runs": false, "do_not_create_commit_status": false, "stale": false, "waiting_for_push": false, "resources": "DEFAULT", "git_changeset_base": "LATEST_RUN", "filesystem_changeset_base": "DATE_MODIFIED", "cpu": "X64", "description_required": false }, "loop": [], "docker_image_name": "library/maven", "docker_image_tag": "3.9.9", "execute_commands": [ "mvn artifact" ], "mount_filesystem_disable": false, "volume_mappings": [ "/:/buddy/my-project" ], "cached_dirs": [ "/root/.m2/repository" ], "shell": "BASH", "region": "", "image_location": "PUBLIC_REGISTRY", "docker_registry": "DOCKER_HUB", "execute_every_command": false, "ignore_image_pull_failures": false, "cache_base_image": true, "reset_entrypoint": false, "vt_suite": "" } } } } }, "security": [ { "oauth2": [ "EXECUTION_INFO" ] } ] }, "delete": { "tags": [ "Action API" ], "summary": "Delete an action from the pipeline", "operationId": "deleteAction", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "pipeline_id", "in": "path", "description": "The ID of the pipeline", "required": true, "schema": { "type": "integer", "format": "int32", "example": 123 } }, { "name": "id", "in": "path", "description": "The ID of the action", "required": true, "schema": { "type": "integer", "format": "int32", "example": 456 } } ], "responses": { "204": { "description": "Action deleted successfully" } }, "security": [ { "oauth2": [ "EXECUTION_MANAGE" ] } ] }, "patch": { "tags": [ "Action API" ], "summary": "Update action configuration", "operationId": "updateAction", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "pipeline_id", "in": "path", "description": "The ID of the pipeline", "required": true, "schema": { "type": "integer", "format": "int32", "example": 123 } }, { "name": "id", "in": "path", "description": "The ID of the action", "required": true, "schema": { "type": "integer", "format": "int32", "example": 456 } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionRequest" }, "examples": { "Update action configuration": { "description": "Update action configuration", "value": { "name": "K8s Helm", "disabled": true, "type": "HELM", "trigger_time": "ON_EVERY_EXECUTION", "trigger_conditions": [ { "trigger_condition": "ON_CHANGE" }, { "trigger_condition": "HOUR", "trigger_hours": [ 8, 9, 10 ], "timezone": "Europe/Warsaw" } ], "targets": [ { "role_arn": "arn:aws:iam::123456789012:role/eks-cluster-service-role", "region": "eu-central-1", "identifier": "my_target_id", "name": "my-target", "integration": "helm", "type": "EKS", "scope": "ACTION", "tags": [ "olive", "orange", "rabsperry" ], "cluster": "https://192.168.5.226:6443" } ], "helm_repository_integration": { "identifier": "helm" }, "helm_repository_region": "us-west-2", "execute_commands": [ "kubectl get namespaces -o=custom-columns=NAME:.metadata.name", "cat ~/.kube/config" ], "setup_commands": [ "helm plugin install https://github.com/hypnoglow/helm-s3.git --version 0.7.0", "helm plugin install https://github.com/hayorov/helm-gcs --version 0.2.1" ], "helm_version": "v3.10.2", "variables": [ { "key": "env_key", "value": "env_value", "type": "VAR", "settable": false, "run_only_settable": false, "encrypted": false, "description": "twcksymvsi" } ], "shell": "BASH", "kubectl_version": "latest", "timeout": 1800, "retry_interval": 60, "retry_count": 5, "ignore_errors": true, "current_revision": "476ac9aabbd84af4a8890c4e3519838669e3ee62", "loop": [ "env_key" ] } }, "Update action name only": { "description": "Update action name only", "value": { "name": "Renamed Action" } }, "Build (BUILD)": { "description": "Build (BUILD)", "value": { "name": "Build Android app", "type": "BUILD", "trigger_time": "ON_EVERY_EXECUTION", "docker_image_name": "library/openjdk", "docker_image_tag": "8", "volume_mappings": [ "/:/buddy/mount/directory" ], "execute_commands": [ "export ANDROID_HOME=/opt/android/sdk", "chmod +x gradlew", "./gradlew assembleRelease" ], "setup_commands": [ "mkdir -p /opt/android/sdk && mkdir .android", "cd /opt/android/sdk && curl -o sdk.zip https://dl.google.com/android/repository/sdk-tools-linux-3859397.zip && unzip sdk.zip && rm sdk.zip", "yes | /opt/android/sdk/tools/bin/sdkmanager --licenses", "/opt/android/sdk/tools/bin/sdkmanager --update", "/opt/android/sdk/tools/bin/sdkmanager platform-tools", "/opt/android/sdk/tools/bin/sdkmanager tools", "/opt/android/sdk/tools/bin/sdkmanager emulator", "/opt/android/sdk/tools/bin/sdkmanager \"extras;android;m2repository\"", "/opt/android/sdk/tools/bin/sdkmanager \"extras;google;m2repository\"", "/opt/android/sdk/tools/bin/sdkmanager \"extras;google;google_play_services\"", "/opt/android/sdk/tools/bin/sdkmanager \"build-tools;27.0.3\"", "/opt/android/sdk/tools/bin/sdkmanager \"platforms;android-27\"" ], "working_directory": "/buddy/my-repo-dir" } }, "Email notification (EMAIL)": { "description": "Email notification (EMAIL)", "value": { "name": "EMAIL Action", "type": "EMAIL", "trigger_time": "ON_EVERY_EXECUTION", "variables": [ { "key": "emailTitle", "value": "Pipeline executed successfully!" } ], "file_attachments": [ "fs:///file1", "fs:///file2" ], "content": "${BUDDY_PIPELINE_NAME} execution #${BUDDY_RUN_ID}", "recipients": "admin@mailinator.com\r\nmanage@mailinator.com", "title": "$emailTitle", "from_name": "Buddy", "send_as_html": true, "send_to_groups": [ "Managers", "Developers" ] } }, "Amazon S3 (AMAZON_S3)": { "description": "Amazon S3 (AMAZON_S3)", "value": { "name": "Upload files to Amazon S3", "type": "AMAZON_S3", "input_type": "SCM_REPOSITORY", "trigger_time": "ON_EVERY_EXECUTION", "local_path": "/assets/", "remote_path": "Home/www/", "bucket_name": "buddy-tests", "acl": "PUBLIC_READ_WRITE", "skip_content_type_setting": false, "reduced_redundancy": true, "expires_date": "2017-01-07T00:00:00.000Z", "cache_control": "max-age=3600", "deploy_tags": [ { "key": "revision", "value": "$BUDDY_RUN_COMMIT" }, { "key": "buddy_last_modification_type", "value": "$BUDDY_EXECUTION_FILE_MODIFICATION_TYPE" } ], "deletion_disabled": true, "deployment_excludes": [ "/tmp/", "*.log" ], "deployment_includes": [ "/assets/style", "/tmp/file.txt" ], "integration": { "identifier": "aws-s3" } } }, "SSH Command (SSH_COMMAND)": { "description": "SSH Command (SSH_COMMAND)", "value": { "name": "Execute commands on 192.0.2.1", "type": "SSH_COMMAND", "trigger_time": "ON_EVERY_EXECUTION", "working_directory": "tests/SSH_Tests/", "commands": [ "date >> tmp.log" ], "targets": [ { "type": "SSH", "identifier": "vlatncuatc", "host": "192.0.2.1", "port": "22", "auth": { "method": "PASSWORD", "username": "buddy", "password": "$MyPassword" } } ], "run_as_script": true, "shell": "BASH", "execute_every_command": false } }, "HTTP Request (HTTP)": { "description": "HTTP Request (HTTP)", "value": { "name": "HTTP Action", "type": "HTTP", "trigger_time": "ON_EVERY_EXECUTION", "variables": [ { "key": "endpointUrl", "value": "http://mywebserver.io" } ], "content": "Pipeline executed successfully!", "notification_url": "$endpointUrl", "port": "1234", "method": "PATCH", "timeout": 120, "headers": [ { "name": "User-Agent", "value": "Buddy" } ] } }, "Visual tests (VISUAL_TESTS)": { "description": "Visual tests (VISUAL_TESTS)", "value": { "name": "Visual Tests", "type": "VISUAL_TESTS", "trigger_time": "ON_EVERY_EXECUTION", "headers": [ { "name": "header1", "value": "value1" }, { "name": "header2", "value": "value2" } ], "resolution_width": 1920, "resolution_height": 1080, "pixel_tolerance_level": 1.23, "images_history_limit": 30, "screenshots": [ { "url": "https://buddy.works/", "baseline": "https://buddy.works/", "headers": [ { "name": "header1", "value": "value1" }, { "name": "header2", "value": "value2" } ], "excluded_areas": [ { "min_x": 200, "min_y": 100, "max_x": 500, "max_y": 200 } ] } ], "permissions": { "others": "DENIED", "users": [ { "id": 1, "access_level": "ALLOWED" } ], "groups": [ { "id": 1, "access_level": "ALLOWED" } ] } } }, "Visual Test 2.0 (VISUAL_TEST_2)": { "description": "Visual Test 2.0 (VISUAL_TEST_2)", "value": { "name": "Visual Test 2.0", "type": "VISUAL_TEST_2", "trigger_time": "ON_EVERY_EXECUTION", "vt_suite": "my_first_suite", "urls": [ "https://example.com", "https://buddy.works" ], "sitemap": "https://buddy.works/sitemap.xml", "urls_file": "pages.txt", "ignore_urls": [ "https://example.com/*" ], "follow": true, "respect_robots": true, "ignores": [ "CSS=.ad-banner" ], "delays": [ "1000" ], "wait_for": [ "CSS=#content" ], "cookies": [ "session=abc123" ], "headers": [ "Authorization=Bearer token" ] } }, "Slack notification (SLACK)": { "description": "Slack notification (SLACK)", "value": { "name": "SLACK Action", "type": "SLACK", "trigger_time": "ON_EVERY_EXECUTION", "content": "Pipeline Execution successful!", "channel": "C024BE91L", "attachments": [ "{\"fallback\":\"${BUDDY_PIPELINE_NAME} execution\",\"color\":\"${color}\",\"fields\":[{\"title\":\"Status\",\"value\":\"Success\"}]}" ], "variables": [ { "key": "color", "value": "good" } ], "file_attachments": [ "fs:///file1", "fs:///file2" ], "integration": { "identifier": "slack" } } }, "Telegram notification (TELEGRAM)": { "description": "Telegram notification (TELEGRAM)", "value": { "name": "Telegram notification", "type": "TELEGRAM", "trigger_time": "ON_EVERY_EXECUTION", "content": "[#$BUDDY_RUN_ID] $BUDDY_PIPELINE_NAME execution by [$BUDDY_INVOKER_NAME]($BUDDY_INVOKER_URL)", "file_attachments": [ "fs:///file1", "fs:///file2" ], "integration": { "identifier": "telegram" } } }, "Discord notification (DISCORD2)": { "description": "Discord notification (DISCORD2)", "value": { "name": "Discord notification", "disabled": true, "type": "DISCORD2", "trigger_time": "ON_EVERY_EXECUTION", "content": "[#BUDDY_EXECUTION_ID] BUDDY_PIPELINE_NAME by BUDDY_INVOKER_NAME", "notification_url": "https://discordapp.com/api/webhooks/453797939572375553/zi3NxdcB6yFW66UN8kece3mT92-u1BpaBUc2CYWoBMrrIJpK7t5lBr5nxFUqc9v9eKX8", "attachments": [ "{\"name\":\"Revision\"}" ], "file_attachments": [ "fs:///fghajxwgad" ], "variables": [ { "key": "env_key", "value": "env_value", "type": "VAR", "settable": false, "run_only_settable": false, "encrypted": false, "description": "kyaawfeucm" } ], "timeout": 1800, "retry_interval": 60, "retry_count": 5, "ignore_errors": true, "current_revision": "21825f31ddce8a89b3ed9f4c92f038b339cde150", "loop": [ "env_key" ] } }, "Microsoft Teams (MICROSOFT_TEAMS)": { "description": "Microsoft Teams (MICROSOFT_TEAMS)", "value": { "name": "Send Microsoft Teams notification", "type": "MICROSOFT_TEAMS", "trigger_time": "ON_EVERY_EXECUTION", "content": "[#$BUDDY_RUN_ID] $BUDDY_PIPELINE_NAME execution by [$BUDDY_INVOKER_NAME]($BUDDY_INVOKER_URL)", "recipients": "example@example.com", "title": "$title", "send_as_html": true, "file_attachments": [ "attachment" ] } }, "Google Chat (GOOGLE_CHAT)": { "description": "Google Chat (GOOGLE_CHAT)", "value": { "name": "Send notification to Google Chat", "type": "GOOGLE_CHAT", "trigger_time": "ON_EVERY_EXECUTION", "content": "Pipeline Execution successful!", "channel": "spaces/AAAA99999", "integration": { "identifier": "google-chat" } } }, "Sms notification (SMS)": { "description": "Sms notification (SMS)", "value": { "name": "SMS Action", "type": "SMS", "trigger_time": "ON_EVERY_EXECUTION", "content": "Pipeline executed successfully!", "recipients": "11234567890\n12345678901" } }, "Pushover (PUSHOVER)": { "description": "Pushover (PUSHOVER)", "value": { "name": "Send notification to My-Chrome", "type": "PUSHOVER", "title": "$title", "trigger_time": "ON_EVERY_EXECUTION", "variables": [ { "key": "title", "value": "Notification title" } ], "content": "${BUDDY_PIPELINE_NAME} execution #${BUDDY_RUN_ID}", "link": "${BUDDY_RUN_URL}", "link_title": "Show execution details", "device": "My-Chrome", "priority": "HIGH", "integration": { "identifier": "pushover" } } }, "Pushbullet (PUSHBULLET)": { "description": "Pushbullet (PUSHBULLET)", "value": { "name": "Send notification to My-Chrome", "type": "PUSHBULLET", "title": "$title", "trigger_time": "ON_EVERY_EXECUTION", "variables": [ { "key": "title", "value": "Notification title" } ], "content": "${BUDDY_PIPELINE_NAME} execution #${BUDDY_RUN_ID}", "link": "${BUDDY_RUN_URL}", "device": "uju3yZ7gq6usjAiVsKnSTs", "integration": { "identifier": "pushbullet" } } }, "Honeybadger (HONEYBADGER)": { "description": "Honeybadger (HONEYBADGER)", "value": { "name": "Honeybadger notification", "type": "HONEYBADGER", "trigger_time": "ON_EVERY_EXECUTION", "variables": [ { "key": "envName", "value": "MyEnv" } ], "integration": { "identifier": "honeybadger" }, "environment": "$envName", "token": "84d1122d" } }, "New Relic notification (NEW_RELIC) ⚠️ DEPRECATED": { "description": "New Relic notification (NEW_RELIC) ⚠️ DEPRECATED", "value": { "name": "NEWRELIC Action", "type": "NEW_RELIC", "trigger_time": "ON_EVERY_EXECUTION", "version": "$BUDDY_RUN_COMMIT", "variables": [ { "key": "content", "value": "changelog content" } ], "description": "${BUDDY_PIPELINE_NAME} execution #${BUDDY_RUN_ID}", "changelog": "${content}", "application_id": "65867123", "integration": { "identifier": "newrelic" } } }, "Rollbar notification (ROLLBAR)": { "description": "Rollbar notification (ROLLBAR)", "value": { "name": "Rollbar Action", "type": "ROLLBAR", "trigger_time": "ON_EVERY_EXECUTION", "user": "mike", "rollbar_username": "MikeB", "application": "123456", "environment": "$envName", "comment": "Deploy comment", "variables": [ { "key": "envName", "value": "MyEnvironment" } ], "integration": { "identifier": "rollbar" } } }, "Sentry notification (SENTRY)": { "description": "Sentry notification (SENTRY)", "value": { "name": "Sentry Action", "type": "SENTRY", "trigger_time": "ON_EVERY_EXECUTION", "organization_slug": "buddyworks", "version": "${BUDDY_RUN_COMMIT}", "environment": "linux", "release_url": "${BUDDY_RUN_COMMIT_URL}", "deploy_url": "${BUDDY_RUN_URL}", "repository": "$BUDDY_REPO_SLUG", "projects": [ "java", "my_proj" ], "integration": { "identifier": "sentry" } } }, "Sentry notification (SENTRY_ENTERPRISE)": { "description": "Sentry notification (SENTRY_ENTERPRISE)", "value": { "name": "Sentry Enterprise Action", "type": "SENTRY_ENTERPRISE", "trigger_time": "ON_EVERY_EXECUTION", "organization_slug": "buddyworks", "version": "${BUDDY_RUN_COMMIT}", "environment": "linux", "release_url": "${BUDDY_RUN_COMMIT_URL}", "deploy_url": "${BUDDY_RUN_URL}", "repository": "$BUDDY_REPO_SLUG", "projects": [ "java", "my_proj" ], "integration": { "identifier": "sentry-enterprise" } } }, "Datadog notification (DATADOG)": { "description": "Datadog notification (DATADOG)", "value": { "name": "Datadog Action", "type": "DATADOG", "trigger_time": "ON_EVERY_EXECUTION", "alert_type": "warning", "variables": [ { "key": "aggregationKey", "value": "someValue" } ], "aggregation_key": "$aggregationKey", "host": "linux", "content": "And let me tell you all about it here!.", "title": "Something big happened!", "region": "EU1", "tags": [ "version:1", "application:web" ], "integration": { "identifier": "datadog" } } }, "Datadog Service Check (DATADOG_STATUS_CHECK)": { "description": "Datadog Service Check (DATADOG_STATUS_CHECK)", "value": { "name": "Datadog Status Check Action", "type": "DATADOG_STATUS_CHECK", "trigger_time": "ON_EVERY_EXECUTION", "variables": [ { "key": "datadogHost", "value": "linux" } ], "host_name": "$datadogHost", "status": 1, "check": "Pipeline Execution", "message": "And let me tell you all about it here!", "region": "EU1", "integration": { "identifier": "datadog" } } }, "Bugsnag (BUGSNAG)": { "description": "Bugsnag (BUGSNAG)", "value": { "name": "Bugsnag notification", "type": "BUGSNAG", "trigger_time": "ON_EVERY_EXECUTION", "version": "$BUDDY_RUN_ID", "release_stage": "$BUDDY_RUN_BRANCH", "token": "$apiKey", "revision": "$BUDDY_RUN_COMMIT", "variables": [ { "key": "apiKey", "value": "secure!rjMzYPhyffqEI8nmd4JPLuv51uhqpzJ4ykx+ilKrTgh9t4+/tGAPhF05EvhpdMj2", "encrypted": true } ], "builder_name": "$BUDDY_INVOKER_NAME", "auto_assign_release": true } }, "Raygun (RAYGUN)": { "description": "Raygun (RAYGUN)", "value": { "name": "Raygun notification", "type": "RAYGUN", "trigger_time": "ON_EVERY_EXECUTION", "variables": [ { "key": "token", "value": "secure!rjMzYPhyffqEI8nmd4JPLuv51uhqpzJ4ykx+ilKrTgh9t4+/tGAPhF05EvhpdMj2", "encrypted": true } ], "version": "$BUDDY_RUN_ID", "token": "$token", "api_key": "cgKu1yviT0HvlYecNEyFg", "email": "$BUDDY_INVOKER_EMAIL", "comment": "$BUDDY_INVOKER_COMMENT" } }, "Loggly (LOGGLY)": { "description": "Loggly (LOGGLY)", "value": { "name": "Loggly notification", "type": "LOGGLY", "trigger_time": "ON_EVERY_EXECUTION", "variables": [ { "key": "tag", "value": "customTag" } ], "integration": { "identifier": "loggly" }, "tags": [ "buddy", "${BUDDY_WORKSPACE_DOMAIN}", "${BUDDY_PROJECT_NAME}", "${BUDDY_PIPELINE_NAME}", "${tag}" ], "content": "Notification content" } }, "Ghost Inspector (GHOST_INSPECTOR)": { "description": "Ghost Inspector (GHOST_INSPECTOR)", "value": { "name": "Ghost Inspector Action", "type": "GHOST_INSPECTOR", "trigger_time": "ON_EVERY_EXECUTION", "variables": [ { "key": "filePath", "value": "variable.csv" } ], "user": "username", "password": "ha16@sdharj21529aA==", "immediate": false, "disable_notification": false, "region": "us-east-1", "browser": "opera", "suite": "5c9ca42171f823532163ef760", "folder": "5cd019551a5fads555105142", "channel": "slack_channel_name", "viewport": "5c9ca42171f8231b363ef760", "data_file": "$filePath", "start_url": "https://app.buddy.works/nickname", "user_agent": "usernameghost", "integration": { "identifier": "ghost-inspector" } } }, "Atop System Monitoring (ATOP)": { "description": "Atop System Monitoring (ATOP)", "value": { "name": "Monitor System Performance", "type": "ATOP", "trigger_time": "ON_EVERY_EXECUTION", "api_url": "https://monitoring.example.com/api/v1/metrics", "parameters": [ { "key": "interval", "value": "60" }, { "key": "duration", "value": "300" } ], "variables": [ { "key": "ATOP_OUTPUT", "value": "/workspace/atop-report.log" } ] } }, "DigitalOcean Spaces (DO_SPACES)": { "description": "DigitalOcean Spaces (DO_SPACES)", "value": { "name": "Upload files to DO Spaces", "type": "DO_SPACES", "input_type": "SCM_REPOSITORY", "trigger_time": "ON_EVERY_EXECUTION", "local_path": "/assets/", "remote_path": "Home/www/", "bucket_name": "buddy-tests", "public_access": true, "cache_control": "max-age=3600", "deployment_excludes": [ "/tmp/", "*.log" ], "deployment_includes": [ "/assets/style", "/tmp/file.txt" ], "integration": { "identifier": "digitalocean" } } }, "Backblaze B2 (BACKBLAZE_B2)": { "description": "Backblaze B2 (BACKBLAZE_B2)", "value": { "name": "Transfer to Backblaze B2", "type": "BACKBLAZE_B2", "input_type": "SCM_REPOSITORY", "trigger_time": "ON_EVERY_EXECUTION", "local_path": "/assets/", "remote_path": "Home/www/", "bucket_name": "buddy-tests", "region": "us-east-005", "cache_control": "max-age=3600", "deletion_disabled": true, "deployment_excludes": [ "/tmp/", "*.log" ], "deployment_includes": [ "/assets/style", "/tmp/file.txt" ], "integration": { "identifier": "backblaze" } } }, "Google Cloud Storage (GOOGLE_CLOUD_STORAGE)": { "description": "Google Cloud Storage (GOOGLE_CLOUD_STORAGE)", "value": { "name": "Upload files to GCS/hello-world-0", "type": "GOOGLE_CLOUD_STORAGE", "trigger_time": "ON_EVERY_EXECUTION", "input_type": "SCM_REPOSITORY", "local_path": "/assets", "remote_path": "/public", "bucket_name": "hello-world-0", "public_access": false, "application_name": "hello-world", "deployment_excludes": [ "/tmp/", "*.log" ], "deployment_includes": [ "/assets/style", "/tmp/file.txt" ], "integration": { "identifier": "gcp" } } }, "Google Cloud Storage (GCS) ⚠️ DEPRECATED": { "description": "Google Cloud Storage (GCS) ⚠️ DEPRECATED", "value": { "name": "Upload files to GCS/hello-world-0", "type": "GCS", "trigger_time": "ON_EVERY_EXECUTION", "input_type": "SCM_REPOSITORY", "local_path": "/assets", "remote_path": "/public", "bucket_name": "hello-world-0", "public_access": false, "application_name": "hello-world", "deployment_excludes": [ "/tmp/", "*.log" ], "deployment_includes": [ "/assets/style", "/tmp/file.txt" ], "integration": { "identifier": "gcp" } } }, "Rackspace (RACKSPACE)": { "description": "Rackspace (RACKSPACE)", "value": { "name": "Upload files to Rackspace", "type": "RACKSPACE", "input_type": "SCM_REPOSITORY", "trigger_time": "ON_EVERY_EXECUTION", "local_path": "/assets/", "remote_path": "Home/www/", "container": "buddy-tests", "region": "IAD", "deployment_excludes": [ "/tmp/", "*.log" ], "deployment_includes": [ "/assets/style", "/tmp/file.txt" ], "integration": { "identifier": "rackspace" } } }, "Shopify (SHOPIFY)": { "description": "Shopify (SHOPIFY)", "value": { "name": "Push to Shopify", "type": "SHOPIFY", "input_type": "SCM_REPOSITORY", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "shopify" }, "theme": "MyTheme", "deployment_excludes": [ "/tmp/", "*.log" ], "deployment_includes": [ "/assets/style", "/tmp/file.txt" ] } }, "WebDAV (WEB_DAV)": { "description": "WebDAV (WEB_DAV)", "value": { "name": "Upload files to localhost", "type": "WEB_DAV", "trigger_time": "ON_EVERY_EXECUTION", "web_dav_url": "https://mysite.com/webdav/", "login": "webdav", "password": "webdav123", "input_type": "SCM_REPOSITORY", "local_path": "/assets/", "remote_path": "Home/www/", "deployment_excludes": [ "/tmp/", "*.log" ], "deployment_includes": [ "/assets/style", "/tmp/file.txt" ] } }, "Transfer (TRANSFER)": { "description": "Transfer (TRANSFER)", "value": { "name": "Upload files to 192.0.2.1 by FTP", "type": "TRANSFER", "trigger_time": "ON_EVERY_EXECUTION", "input_type": "SCM_REPOSITORY", "local_path": "/", "remote_path": "", "compress": true, "targets": [ { "identifier": "ftp_target_1", "type": "FTP", "secure": false, "host": "192.0.2.1", "port": "21", "auth": { "username": "user", "password": "$MyPassword" }, "path": "/var/www" } ] } }, "Azure Storage (AZURE_STORAGE)": { "description": "Azure Storage (AZURE_STORAGE)", "value": { "name": "Upload files to Azure Storage", "type": "AZURE_STORAGE", "input_type": "BUILD_ARTIFACTS", "trigger_time": "ON_EVERY_EXECUTION", "local_path": "/assets", "remote_path": "/remote", "bucket_name": "buddytest", "deletion_disabled": true, "integration": { "identifier": "azure" }, "application_name": "buddytests", "skip_content_type_setting": false, "deployment_excludes": [ "/tmp/", "*.log" ], "deployment_includes": [ "/assets/style", "/tmp/file.txt" ] } }, "Deploy to Sandbox (DEPLOY_TO_SANDBOX) ⚠️ DEPRECATED": { "description": "Deploy to Sandbox (DEPLOY_TO_SANDBOX) ⚠️ DEPRECATED", "value": { "name": "Deploy to Development Sandbox", "type": "DEPLOY_TO_SANDBOX", "trigger_time": "ON_EVERY_EXECUTION", "sandbox_id": "ghwmnj2az2k67", "sandbox_references": [ "BY_ID" ], "local_path": "/dist", "remote_path": "/var/www/app", "user": "www-data", "input_type": "BUILD_ARTIFACTS", "deployment_excludes": [ "*.log", "*.tmp", "node_modules/*" ], "deployment_includes": [ "**/*.html", "**/*.js", "**/*.css" ], "deletion_disabled": false, "use_temporary_files": true } }, "Publish Artifact (PUBLISH_ARTIFACT_VERSION)": { "description": "Publish Artifact (PUBLISH_ARTIFACT_VERSION)", "value": { "name": "Publish NPM Artifact", "type": "PUBLISH_ARTIFACT_VERSION", "trigger_time": "ON_EVERY_EXECUTION", "artifact": "my-company/ui-components", "versions": [ "3.2.1" ], "local_path": "/dist", "remote_path": "/artifacts", "input_type": "BUILD_ARTIFACTS", "deployment_excludes": [ "*.map", "*.test.js" ], "deployment_includes": [ "**/*.js", "**/*.css", "package.json" ], "deletion_disabled": true } }, "Powershell Command (POWERSHELL)": { "description": "Powershell Command (POWERSHELL)", "value": { "name": "Deploy PowerShell Scripts to Windows Server", "type": "POWERSHELL", "trigger_time": "ON_EVERY_EXECUTION", "working_directory": "C:\\Deployment\\Scripts", "commands": [ "Write-Host \"Starting deployment\"", "Stop-Service MyAppService -Force", "Copy-Item -Path .\\* -Destination C:\\Apps\\MyApp -Recurse -Force", "Start-Service MyAppService", "Get-Service MyAppService" ], "targets": [ { "type": "SSH", "identifier": "prod_win_server", "host": "10.0.1.50", "port": "22", "auth": { "method": "PASSWORD", "username": "deploy_user", "password": "$DEPLOY_PASSWORD" } } ], "run_as_script": true, "execute_every_command": false } }, "Execute in Sandbox (SANDBOX_EXEC) ⚠️ DEPRECATED": { "description": "Execute in Sandbox (SANDBOX_EXEC) ⚠️ DEPRECATED", "value": { "name": "Run Database Migrations", "type": "SANDBOX_EXEC", "trigger_time": "ON_EVERY_EXECUTION", "sandbox_id": "ghwmnj2az2k67", "sandbox_references": [ "BY_ID" ], "working_directory": "/var/www/app", "commands": [ "php artisan migrate --force", "php artisan cache:clear" ], "shell": "bash", "execute_every_command": true, "user": "www-data" } }, "Git Push (PUSH)": { "description": "Git Push (PUSH)", "value": { "name": "Push to GitHub repo", "disabled": true, "type": "PUSH", "trigger_time": "ON_EVERY_EXECUTION", "trigger_conditions": [ { "trigger_condition": "ON_CHANGE" }, { "trigger_condition": "HOUR", "trigger_hours": [ 8, 9, 10 ], "timezone": "Europe/Warsaw" } ], "deployment_excludes": [ "/assets/", "/myDir" ], "targets": [ { "identifier": "git-push", "name": "my-git-target", "type": "GIT", "auth": { "username": "user", "password": "pass1234", "method": "HTTP" }, "repository": "https://github.com/example/my-repository" } ], "target_branch": "BUDDY_EXECUTION_BRANCH", "tag": "tagName", "custom_options": "--no-verify", "comment": "BUDDY_RUN_ID", "isolated": false, "push_tags": true, "use_custom_gitignore": true, "without_force": false, "timeout": 1800, "retry_interval": 60, "retry_count": 5, "ignore_errors": true, "current_revision": "21825f31ddce8a89b3ed9f4c92f038b339cde150" } }, "Azure (AZURE)": { "description": "Azure (AZURE)", "value": { "name": "Push to Your Repo", "type": "AZURE", "git_auth_mode": "HTTP", "trigger_time": "ON_EVERY_EXECUTION", "push_url": "https://buddytestapp.scm.azurewebsites.net:443/BuddyTestApp.git", "login": "api_tests_user", "password": "api_tests_password", "isolated": true, "target_branch": "stage", "deployment_excludes": [ "/tmp/", "*.log" ] } }, "Heroku (HEROKU)": { "description": "Heroku (HEROKU)", "value": { "name": "Push to Your Repo", "type": "HEROKU", "trigger_time": "ON_EVERY_EXECUTION", "use_custom_gitignore": true, "isolated": true, "integration": { "identifier": "heroku" }, "application_name": "AppName", "deployment_excludes": [ "/tmp/", "*.log" ] } }, "Web monitoring (WEB)": { "description": "Web monitoring (WEB)", "value": { "name": "Check http://buddy.works/ status", "type": "WEB", "trigger_time": "ON_EVERY_EXECUTION", "login": "owner@buddy.works", "password": "secure!TPR+DWaI7z47j6Ns4kkSJQ==", "port": "8080", "destination": "http://buddy.works/", "post_data": "{ \"test\": \"ok\" }", "headers": [ { "name": "User-Agent", "value": "Buddy" }, { "name": "myHeader", "value": "myHeaderValue" } ], "text_existence": true, "text": "ok" } }, "TCP monitoring (TCP)": { "description": "TCP monitoring (TCP)", "value": { "name": "Check site status", "type": "TCP", "trigger_time": "ON_EVERY_EXECUTION", "variables": [ { "key": "hostName", "value": "app.buddy.works" } ], "port": "8080", "destination": "$hostName", "post_data": "{ \"test\": \"ok\" }", "text": "ok" } }, "Ping monitoring (PING)": { "description": "Ping monitoring (PING)", "value": { "name": "Ping Action", "type": "PING", "trigger_time": "ON_EVERY_EXECUTION", "destination": "$host", "variables": [ { "key": "host", "value": "app.buddy.works" } ] } }, "Build Storybook (STORYBOOK)": { "description": "Build Storybook (STORYBOOK)", "value": { "name": "Build Component Documentation", "type": "STORYBOOK", "trigger_time": "ON_EVERY_EXECUTION", "working_directory": "/", "docker_image_name": "node", "docker_image_tag": "20-alpine", "setup_commands": [ "npm ci" ], "execute_commands": [ "npm run build-storybook" ], "execute_every_command": true, "cached_dirs": [ "node_modules" ], "export_container_path": "/storybook-static" } }, "Custom Action (CUSTOM)": { "description": "Custom Action (CUSTOM)", "value": { "name": "My custom action", "type": "CUSTOM", "trigger_time": "ON_EVERY_EXECUTION", "custom_type": "my_custom_action:latest", "variables_access": true, "filesystem_access": true, "inputs": [ { "id": "cmd", "value": "echo 'Hello world'" }, { "id": "other_custom_input", "value": "some value" } ] } }, "Run Docker container (RUN_DOCKER_CONTAINER)": { "description": "Run Docker container (RUN_DOCKER_CONTAINER)", "value": { "name": "Run container", "type": "RUN_DOCKER_CONTAINER", "trigger_time": "ON_EVERY_EXECUTION", "docker_image_name": "library/ubuntu", "docker_image_tag": "latest", "inline_commands": "ls -al > ls.log", "run_as_user": "$containerUser", "mount_filesystem_disable": false, "export_container_path": "/exportPath", "volume_mappings": [ "/:/buddy/mount/directory" ], "integration": { "identifier": "docker-registry" }, "variables": [ { "key": "containerUser", "value": "notRoot" } ], "entrypoint": "/bin/sh" } }, "Build Docker Image (DOCKERFILE)": { "description": "Build Docker Image (DOCKERFILE)", "value": { "name": "Build dockerfile", "type": "DOCKERFILE", "trigger_time": "ON_EVERY_EXECUTION", "docker_image_tag": "14.06", "region": "us-east-1", "integration": { "identifier": "docker-registry" }, "dockerfile_path": "dir/Dockerfile", "repository": "MyDockerRepo", "insecure_registry": true, "do_not_prune_images": true, "secrets": [ { "id": "someSecret", "value": "path_to_secret", "type": "FILE" }, { "id": "mysecret", "value": "MY_ENV_VAR_KEY", "type": "ENV" } ], "build_args": [ "key=value" ] } }, "Build multi-arch image (DOCKER_BUILD_MULTI_ARCH)": { "description": "Build multi-arch image (DOCKER_BUILD_MULTI_ARCH)", "value": { "name": "Build multi-arch image", "type": "DOCKER_BUILD_MULTI_ARCH", "trigger_time": "ON_EVERY_EXECUTION", "build_args": [ "key=value" ], "dockerfile_path": "Dockerfile", "context_path": "/contextPath", "target_stage": "$targetStage", "secrets": [ { "id": "$secretId", "value": "$path_to_secret", "type": "FILE" } ], "target_platform": "linux/amd64,linux/arm64" } }, "Push Docker Image (DOCKER_PUSH)": { "description": "Push Docker Image (DOCKER_PUSH)", "value": { "name": "Push to registry", "type": "DOCKER_PUSH", "trigger_time": "ON_EVERY_EXECUTION", "docker_image_tag": "14.06", "region": "us-east-1", "integration": { "identifier": "docker-registry" }, "docker_build_action_id": 1, "repository": "MyDockerRepo" } }, "Google App Engine (GOOGLE_APP_DEPLOY)": { "description": "Google App Engine (GOOGLE_APP_DEPLOY)", "value": { "name": "Deploy to Google App Engine/buddy-tests-112923", "type": "GOOGLE_APP_DEPLOY", "trigger_time": "ON_EVERY_EXECUTION", "local_path": "/", "bucket_name": "artifacts.tokyo-house-112923.appspot.com", "application_name": "buddy-tests-112923", "version_label": "${BUDDY_RUN_COMMIT}", "image_url": "gcr.io/your-project-id/your-image", "promote_all_traffic": true, "stop_previous_version": true, "verbosity": "warning" } }, "Google App Engine (GOOGLE_APP_ENGINE) ⚠️ DEPRECATED": { "description": "Google App Engine (GOOGLE_APP_ENGINE) ⚠️ DEPRECATED", "value": { "name": "Deploy to Google App Engine/buddy-tests-112923", "type": "GOOGLE_APP_ENGINE", "trigger_time": "ON_EVERY_EXECUTION", "local_path": "/", "bucket_name": "artifacts.tokyo-house-112923.appspot.com", "application_name": "buddy-tests-112923", "version_label": "${BUDDY_RUN_COMMIT}", "image_url": "gcr.io/your-project-id/your-image", "promote_all_traffic": true, "stop_previous_version": true, "verbosity": "warning" } }, "Google Cloud CLI (GOOGLE_CLOUD_CLI)": { "description": "Google Cloud CLI (GOOGLE_CLOUD_CLI)", "value": { "name": "Execute: gcloud version", "type": "GOOGLE_CLOUD_CLI", "trigger_time": "ON_EVERY_EXECUTION", "setup_commands": [ "apt-get update && apt-get -y install git" ], "execute_commands": [ "gcloud version" ], "shell": "SH", "version": "521.0.0", "application_name": "boxwood-builder-150909", "integration": { "identifier": "gcp" } } }, "GCloud CLI (GCLOUD_CLI) ⚠️ DEPRECATED": { "description": "GCloud CLI (GCLOUD_CLI) ⚠️ DEPRECATED", "value": { "name": "Execute: gcloud version", "type": "GCLOUD_CLI", "trigger_time": "ON_EVERY_EXECUTION", "setup_commands": [ "apt-get update && apt-get -y install git" ], "execute_commands": [ "gcloud version" ], "shell": "SH", "version": "521.0.0", "application_name": "boxwood-builder-150909", "integration": { "identifier": "gcp" } } }, "Google Cloud Run Deploy (GOOGLE_CLOUD_RUN_DEPLOY)": { "description": "Google Cloud Run Deploy (GOOGLE_CLOUD_RUN_DEPLOY)", "value": { "name": "Deploy to Google Cloud Run/84 tests", "type": "GOOGLE_CLOUD_RUN_DEPLOY", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "gcp" }, "application_name": "MyApp", "region": "europe-west1", "service": "$service", "image": "$image", "platform": "MANAGED" } }, "GCloud Run Deploy (GCLOUD_RUN_DEPLOY) ⚠️ DEPRECATED": { "description": "GCloud Run Deploy (GCLOUD_RUN_DEPLOY) ⚠️ DEPRECATED", "value": { "name": "Deploy to Google Cloud Run/84 tests", "type": "GCLOUD_RUN_DEPLOY", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "gcp" }, "application_name": "MyApp", "region": "europe-west1", "service": "$service", "image": "$image", "platform": "MANAGED" } }, "Heroku CLI (HEROKU_CLI)": { "description": "Heroku CLI (HEROKU_CLI)", "value": { "name": "Execute commands on Heroku", "type": "HEROKU_CLI", "trigger_time": "ON_EVERY_EXECUTION", "variables": [ { "key": "appName", "value": "my-app" } ], "setup_commands": [ "apt-get update && apt-get -y install git" ], "execute_commands": [ "heroku run ls -al --app $appName" ], "shell": "SH", "application_name": "AppName", "integration": { "identifier": "heroku" } } }, "AWS CLI (AWS_CLI)": { "description": "AWS CLI (AWS_CLI)", "value": { "name": "Run AWS command", "type": "AWS_CLI", "trigger_time": "ON_EVERY_EXECUTION", "setup_commands": [ "apt-get update && apt-get -y install git" ], "execute_commands": [ "aws lambda $command" ], "shell": "SH", "variables": [ { "key": "command", "value": "list-functions" } ], "integration": { "identifier": "aws" }, "region": "us-west-2" } }, "AWS CLI 2 (AWS_CLI_2)": { "description": "AWS CLI 2 (AWS_CLI_2)", "value": { "name": "Execute: aws lambda list-functions", "type": "AWS_CLI_2", "trigger_time": "ON_EVERY_EXECUTION", "setup_commands": [ "apt-get update && apt-get -y install git" ], "execute_commands": [ "aws lambda list-functions" ], "shell": "SH", "integration": { "identifier": "aws" }, "region": "us-west-2" } }, "AWS CloudFormation (AWS_CLOUD_FORMATION)": { "description": "AWS CloudFormation (AWS_CLOUD_FORMATION)", "value": { "name": "Execute: create CloudFormation", "disabled": true, "type": "AWS_CLOUD_FORMATION", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "yfsctqutdt", "name": "slskopytko", "type": "AMAZON", "scope": "WORKSPACE" }, "region": "us-west-2", "execute_commands": [ "#VALIDATE", "aws cloudformation validate-template --template-body file:///stacks/sampletemplate.json", "#CREATE", "aws cloudformation create-stack --stack-name testsstack --template-body file:///stacks/sampletemplate.json --parameters ParameterKey=Key1,ParameterValue=Val1 --tags Key=Env,Value=ENV", "#WAIT UNTIL READY", "aws cloudformation wait stack-create-complete --stack-name testsstack" ], "setup_commands": [ "apt-get update", "apt-get install -y curl" ], "variables": [ { "key": "env_key", "value": "env_value", "type": "VAR", "settable": false, "run_only_settable": false, "encrypted": false, "description": "gwghjuafon" } ], "timeout": 1800, "retry_interval": 60, "retry_count": 5, "ignore_errors": true, "current_revision": "21825f31ddce8a89b3ed9f4c92f038b339cde150", "loop": [ "env_key" ] } }, "AWS Lambda Deploy (AWS_LAMBDA_DEPLOY)": { "description": "AWS Lambda Deploy (AWS_LAMBDA_DEPLOY)", "value": { "name": "Deploy function hello-world", "type": "AWS_LAMBDA_DEPLOY", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "aws" }, "region": "us-east-1", "function_name": "hello-world", "local_path": "/", "deployment_excludes": [ "/tmp/", "*.log" ], "deployment_includes": [ "/assets/style", "/tmp/file.txt" ] } }, "Google Function Deploy (GOOGLE_FUNCTION_DEPLOY)": { "description": "Google Function Deploy (GOOGLE_FUNCTION_DEPLOY)", "value": { "name": "Deploy function hello-world", "type": "GOOGLE_FUNCTION_DEPLOY", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "gcp" }, "application_id": "hello-world", "function_name": "hello-world-0", "command_args": "--trigger-http", "runtime": "nodejs12", "local_path": "/", "region": "europe-west3" } }, "Google Functions Deploy (GOOGLE_FUNCTIONS_DEPLOY) ⚠️ DEPRECATED": { "description": "Google Functions Deploy (GOOGLE_FUNCTIONS_DEPLOY) ⚠️ DEPRECATED", "value": { "name": "Deploy function hello-world", "type": "GOOGLE_FUNCTIONS_DEPLOY", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "gcp" }, "application_id": "hello-world", "function_name": "hello-world-0", "command_args": "--trigger-http", "runtime": "nodejs12", "local_path": "/", "region": "europe-west3" } }, "Trigger pipeline (RUN_NEXT_PIPELINE)": { "description": "Trigger pipeline (RUN_NEXT_PIPELINE)", "value": { "name": "Trigger Pipeline Action", "type": "RUN_NEXT_PIPELINE", "trigger_time": "ON_EVERY_EXECUTION", "environment": "$BUDDY_RUN_ENV_ID", "comment": "Triggered by $BUDDY_PIPELINE_NAME execution #$BUDDY_EXECUTION_ID", "next_pipeline": { "id": 185088 }, "revision": "SPECIFIC", "specific_revision": "#$BUDDY_EXECUTION_REF", "wait": true, "clear_cache": true, "refresh": true, "priority": "LOW", "variables": [ { "key": "key", "value": "buddy", "type": "VAR", "settable": true, "description": "" } ], "artifact": "$BUDDY_RUN_ARTIFACT_VERSION" } }, "Copy files (COPY_FILES)": { "description": "Copy files (COPY_FILES)", "value": { "name": "Copy files from another pipeline", "type": "COPY_FILES", "copy_hidden_files": true, "trigger_time": "ON_EVERY_EXECUTION", "source_pipeline": { "id": 2 }, "target_pipeline": { "id": 3 }, "source_path": "/", "target_path": "Home/www/", "deployment_excludes": [ "/tmp/", "*.log" ], "deployment_includes": [ "/assets/style", "/tmp/file.txt" ] } }, "Wait for apply (WAIT_FOR_APPLY)": { "description": "Wait for apply (WAIT_FOR_APPLY)", "value": { "name": "Wait for manual apply", "type": "WAIT_FOR_APPLY", "trigger_time": "ON_EVERY_EXECUTION", "comment": "Do you want to deploy ${BUDDY_RUN_COMMIT} to Production?", "prevent_self_approval": true, "permissions": { "others": "DENIED", "users": [ { "id": 1, "access_level": "ALLOWED" } ], "groups": [ { "id": 1, "access_level": "ALLOWED" } ] } } }, "Pass arguments (WAIT_FOR_VARIABLES)": { "description": "Pass arguments (WAIT_FOR_VARIABLES)", "value": { "name": "Pass parameters", "type": "WAIT_FOR_VARIABLES", "trigger_time": "ON_EVERY_EXECUTION", "comment": "Version should be like X.Y.Z", "variables": [ { "key": "version" }, { "key": "pass", "encrypted": true } ], "permissions": { "others": "DENIED", "users": [ { "id": 1, "access_level": "ALLOWED" } ], "groups": [ { "id": 1, "access_level": "ALLOWED" } ] } } }, "Set variables (SET_VARIABLES)": { "description": "Set variables (SET_VARIABLES)", "value": { "name": "Set Variables", "type": "SET_VARIABLES", "trigger_time": "ON_EVERY_EXECUTION", "comment": "comment", "variables": [ { "key": "var3", "init_path": "/fileWithOptions" }, { "key": "var2", "defaults": "option1\noption2" }, { "key": "var1" }, { "key": "var4" } ], "permissions": { "others": "DENIED", "users": [ { "id": 1, "access_level": "ALLOWED" } ], "groups": [ { "id": 1, "access_level": "ALLOWED" } ] } } }, "Approve VT (APPROVE_VT)": { "description": "Approve VT (APPROVE_VT)", "value": { "name": "Wait for VT approve", "type": "APPROVE_VT", "trigger_time": "ON_EVERY_EXECUTION", "comment": "Please review and approve the visual tests", "description": "Waiting for visual test session approval", "from_action": "Visual tests", "ref": "refs/heads/main", "permissions": { "others": "DENIED", "users": [ { "id": 1, "access_level": "ALLOWED" } ], "groups": [ { "id": 1, "access_level": "ALLOWED" } ] } } }, "Elastic Beanstalk (ELASTIC_BEANSTALK)": { "description": "Elastic Beanstalk (ELASTIC_BEANSTALK)", "value": { "name": "Upload files to Elastic Beanstalk/tests", "type": "ELASTIC_BEANSTALK", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "aws" }, "application_name": "tests", "region": "us-east-1", "environment": "e-rnuptbebz2", "version_label": "NewVersion", "deployment_excludes": [ "/tmp/", "*.log" ], "deployment_includes": [ "/assets/style", "/tmp/file.txt" ] } }, "Code Deploy (CODE_DEPLOY)": { "description": "Code Deploy (CODE_DEPLOY)", "value": { "name": "Upload files to Code Deploy", "type": "CODE_DEPLOY", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "aws" }, "local_path": "/", "application_name": "tests", "region": "us-east-1", "group_name": "DemoFleet", "config_name": "CodeDeployDefault.OneAtATime", "description": "Deploy comment.", "ignore_application_stop_failures": false, "update_outdated_instances_only": false, "wait_for_finish_deployment": true, "file_exist_behavior": "OVERWRITE", "deployment_excludes": [ "/tmp/", "*.log" ], "deployment_includes": [ "/assets/style", "/tmp/file.txt" ] } }, "AWS App Runner Deploy (AWS_APP_RUNNER_DEPLOY)": { "description": "AWS App Runner Deploy (AWS_APP_RUNNER_DEPLOY)", "value": { "name": "App Runner Deploy", "type": "AWS_APP_RUNNER_DEPLOY", "trigger_time": "ON_EVERY_EXECUTION", "service": "arn-aws-apprunner-service", "region": "us-east-1", "integration": { "identifier": "aws" } } }, "AWS ECS (AWS_ECS)": { "description": "AWS ECS (AWS_ECS)", "value": { "name": "ECS by API", "type": "AWS_ECS", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "aws" }, "service": "sample-app-service", "cluster": "buddy-testing-cluster", "local_path": "taskDefinition.json", "region": "us-east-1" } }, "AWS Lambda (LAMBDA)": { "description": "AWS Lambda (LAMBDA)", "value": { "name": "Invoke function hello-world", "type": "LAMBDA", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "aws" }, "region": "us-east-1", "function_name": "hello-world", "qualifier": "", "invocation_type": "RequestResponse", "log_type": "Tail", "client_context": "", "payload": "{ \"revision\": \"${BUDDY_RUN_COMMIT}\", \"message\": \"${BUDDY_RUN_COMMIT_MESSAGE}\" }" } }, "Google Functions (GOOGLE_FUNCTIONS) ⚠️ DEPRECATED": { "description": "Google Functions (GOOGLE_FUNCTIONS) ⚠️ DEPRECATED", "value": { "name": "Invoke function hello-world-0", "type": "GOOGLE_FUNCTIONS", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "gcp" }, "function_name": "hello-world-0", "payload": "{ \"revision\": \"$BUDDY_RUN_COMMIT\", \"message\": \"$BUDDY_RUN_COMMIT_MESSAGE\" }" } }, "Google Function Invoke (GOOGLE_FUNCTION_INVOKE)": { "description": "Google Function Invoke (GOOGLE_FUNCTION_INVOKE)", "value": { "name": "Invoke function hello-world-0", "type": "GOOGLE_FUNCTION_INVOKE", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "gcp" }, "function_name": "hello-world-0", "payload": "{ \"revision\": \"$BUDDY_RUN_COMMIT\", \"message\": \"$BUDDY_RUN_COMMIT_MESSAGE\" }" } }, "Cloudflare (CLOUDFLARE)": { "description": "Cloudflare (CLOUDFLARE)", "value": { "name": "Cloudflare action", "type": "CLOUDFLARE", "trigger_time": "ON_EVERY_EXECUTION", "input_type": "SCM_REPOSITORY", "local_path": "/", "zone_id": "f00e1e106ca13e658477bf7393ad83f1", "base_url": "https://buddy.works", "purge_all": false, "integration": { "identifier": "cloudflare" }, "deployment_excludes": [ "/tmp/", "*.log" ], "deployment_includes": [ "/assets/style", "/tmp/file.txt" ] } }, "CloudFront (CLOUD_FRONT)": { "description": "CloudFront (CLOUD_FRONT)", "value": { "name": "Cloudfront action", "type": "CLOUD_FRONT", "trigger_time": "ON_EVERY_EXECUTION", "input_type": "SCM_REPOSITORY", "local_path": "/", "base_url": "/merged", "distribution_id": "EDFDVBD632BHDS5", "purge_all": false, "timeout": 900, "integration": { "identifier": "aws" }, "deployment_excludes": [ "/tmp/", "*.log" ], "deployment_includes": [ "/assets/style", "/tmp/file.txt" ] } }, "Google CDN (GOOGLE_CDN_INVALIDATE)": { "description": "Google CDN (GOOGLE_CDN_INVALIDATE)", "value": { "name": "Purge cache at hello-world / hello-world-cdn", "type": "GOOGLE_CDN_INVALIDATE", "trigger_time": "ON_EVERY_EXECUTION", "input_type": "SCM_REPOSITORY", "remote_path": "/merged", "distribution_id": "hello-world", "purge_all": false, "url_map": "hello-world-cdn", "integration": { "identifier": "gcp" }, "deployment_excludes": [ "/tmp/", "*.log" ], "deployment_includes": [ "/tmp/assets", "/tmp/styles" ] } }, "Google CDN (GOOGLE_CDN) ⚠️ DEPRECATED": { "description": "Google CDN (GOOGLE_CDN) ⚠️ DEPRECATED", "value": { "name": "Purge cache at hello-world / hello-world-cdn", "type": "GOOGLE_CDN", "trigger_time": "ON_EVERY_EXECUTION", "input_type": "SCM_REPOSITORY", "remote_path": "/merged", "distribution_id": "hello-world", "purge_all": false, "url_map": "hello-world-cdn", "integration": { "identifier": "gcp" }, "deployment_excludes": [ "/tmp/", "*.log" ], "deployment_includes": [ "/tmp/assets", "/tmp/styles" ] } }, "DigitalOcean CDN (DIGITAL_OCEAN_CDN)": { "description": "DigitalOcean CDN (DIGITAL_OCEAN_CDN)", "value": { "name": "DigitalOcean CDN", "type": "DIGITAL_OCEAN_CDN", "trigger_time": "ON_EVERY_EXECUTION", "input_type": "SCM_REPOSITORY", "local_path": "/", "remote_path": "/merged", "endpoint": "df590699-f862-45d1-aad0-0e74280ebe50", "purge_all": false, "integration": { "identifier": "digitalocean" }, "deployment_excludes": [ "/tmp/", "*.log" ], "deployment_includes": [ "/assets/style", "/tmp/file.txt" ] } }, "Rsync (RSYNC)": { "description": "Rsync (RSYNC)", "value": { "name": "Sync files", "disabled": true, "type": "RSYNC", "trigger_time": "ON_EVERY_EXECUTION", "local_path": "/source_path", "remote_path": "/target_path", "deployment_excludes": [ "/assets/", "/myDir" ], "deployment_includes": [ "/assets/dir", "/myDir/dir1" ], "archive": false, "compress": false, "recursive": true, "dirs": true, "delete_extra_files": true, "targets": [ { "identifier": "my_target_id", "name": "my-target", "type": "SSH", "scope": "ACTION", "path": "target/path/on/server", "host": "my-server.tests", "port": "1234", "auth": { "username": "my-user", "password": "my-password", "method": "PASSWORD" }, "tags": [ "olive", "orange", "rabsperry" ] } ], "variables": [ { "key": "env_key", "value": "env_value", "type": "VAR", "settable": false, "run_only_settable": false, "encrypted": false, "description": "nnnmstgikb" } ], "timeout": 1800, "retry_interval": 60, "retry_count": 5, "ignore_errors": true, "arguments": "--times --links", "current_revision": "21825f31ddce8a89b3ed9f4c92f038b339cde150", "loop": [ "env_key" ] } }, "Elastic Beanstalk Monitor (MONITOR)": { "description": "Elastic Beanstalk Monitor (MONITOR)", "value": { "name": "Monitor Elastic Beanstalk/tests", "type": "MONITOR", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "aws" }, "application_name": "tests", "region": "us-west-2", "environment": "e-rnuptbebz2", "fail_on_yellow": true, "verbose": false, "timeout": 600 } }, "AWS App Runner Monitor (AWS_APP_RUNNER_MONITOR)": { "description": "AWS App Runner Monitor (AWS_APP_RUNNER_MONITOR)", "value": { "name": "App Runner Monitor", "type": "AWS_APP_RUNNER_MONITOR", "trigger_time": "ON_EVERY_EXECUTION", "service": "arn-aws-apprunner-service", "region": "us-east-1", "integration": { "identifier": "aws" }, "timeout": 5400 } }, "Sleep (SLEEP)": { "description": "Sleep (SLEEP)", "value": { "name": "Sleep well, darling", "type": "SLEEP", "trigger_time": "ON_EVERY_EXECUTION", "sleep_in_sec": 600 } }, "GKE Apply Deployment (KUBERNETES_APPLY)": { "description": "GKE Apply Deployment (KUBERNETES_APPLY)", "value": { "name": "Apply deployment", "type": "KUBERNETES_APPLY", "trigger_time": "ON_EVERY_EXECUTION", "targets": [ { "zone": "europe-west1-c", "project_id": "tokyo-house-138923", "identifier": "my_target_id", "name": "my-target", "integration": "5ddb7c180fb38be67bd78a88a", "type": "GKE", "scope": "ACTION", "tags": [ "olive", "orange", "rabsperry" ], "cluster": "cluster-1" } ], "config_path": "config.yaml", "record_arg": "NOT_SET", "save_config_arg": false, "force_arg": false, "overwrite_arg": false, "cascade_arg": false, "all_arg": true, "grace_period_arg": 0, "prune_arg": true, "prune_whitelist_arg": "", "timeout": "600" } }, "GKE Set Image (KUBERNETES_SET_IMAGE)": { "description": "GKE Set Image (KUBERNETES_SET_IMAGE)", "value": { "name": "Set image", "type": "KUBERNETES_SET_IMAGE", "trigger_time": "ON_EVERY_EXECUTION", "targets": [ { "zone": "europe-west1-c", "project_id": "tokyo-house-138923", "identifier": "my_target_id", "name": "my-target", "integration": "5ddb7c180fb38be67bd78a88a", "type": "GKE", "scope": "ACTION", "tags": [ "olive", "orange", "rabsperry" ], "cluster": "cluster-1" } ], "deployment": "nginx-deployment", "namespace": "default", "image_name": "nginx", "image_tag": "1.7.8", "record_arg": "NOT_SET", "container": "nginx" } }, "GKE Run Pod (KUBERNETES_RUN_POD)": { "description": "GKE Run Pod (KUBERNETES_RUN_POD)", "value": { "name": "Run Pod", "type": "KUBERNETES_RUN_POD", "trigger_time": "ON_EVERY_EXECUTION", "targets": [ { "zone": "europe-west1-c", "project_id": "tokyo-house-138923", "identifier": "my_target_id", "name": "my-target", "integration": "5ddb7c180fb38be67bd78a88a", "type": "GKE", "scope": "ACTION", "tags": [ "olive", "orange", "rabsperry" ], "cluster": "cluster-1" } ], "record_arg": "NOT_SET", "leave_after": true, "not_wait": true, "config_path": "config.yaml" } }, "GKE Run Job (KUBERNETES_RUN_JOB)": { "description": "GKE Run Job (KUBERNETES_RUN_JOB)", "value": { "name": "Run job", "type": "KUBERNETES_RUN_JOB", "trigger_time": "ON_EVERY_EXECUTION", "targets": [ { "zone": "europe-west1-c", "project_id": "tokyo-house-138923", "identifier": "my_target_id", "name": "my-target", "integration": "5ddb7c180fb38be67bd78a88a", "type": "GKE", "scope": "ACTION", "tags": [ "olive", "orange", "rabsperry" ], "cluster": "cluster-1" } ], "record_arg": "NOT_SET", "leave_after": true, "not_wait": true, "config_path": "config.yaml" } }, "GKE kubectl (KUBERNETES_CLI)": { "description": "GKE kubectl (KUBERNETES_CLI)", "value": { "name": "GKE CLI", "disabled": true, "type": "KUBERNETES_CLI", "trigger_time": "ON_EVERY_EXECUTION", "targets": [ { "zone": "europe-west3-a", "project_id": "tests-buddy", "identifier": "my_target_id", "name": "my-target", "integration": "hlgqrrbcni", "type": "GKE", "scope": "ACTION", "tags": [ "olive", "orange", "rabsperry" ], "cluster": "buddy-tests" } ], "execute_commands": [ "kubectl get namespaces -o=custom-columns=NAME:.metadata.name", "cat ~/.kube/config" ], "execute_every_command": true, "setup_commands": [ "apt-get update" ], "variables": [ { "key": "env_key", "value": "env_value", "type": "VAR", "settable": false, "run_only_settable": false, "encrypted": false, "description": "vnxmrlbjgo" } ], "shell": "BASH", "kubectl_version": "latest", "timeout": 1800, "retry_interval": 60, "retry_count": 5, "ignore_errors": true, "current_revision": "21825f31ddce8a89b3ed9f4c92f038b339cde150", "loop": [ "env_key" ] } }, "MySQL CLI (MYSQL_CLI)": { "description": "MySQL CLI (MYSQL_CLI)", "value": { "name": "Run MySQL queries", "type": "MYSQL_CLI", "trigger_time": "ON_EVERY_EXECUTION", "version": "8.0", "shell": "BASH", "execute_commands": [ "mysql -e 'SHOW DATABASES'", "mysql < migrate.sql" ], "targets": [ { "identifier": "my_database", "name": "My MySQL Database", "type": "MYSQL", "scope": "ACTION", "host": "db.example.com", "port": 3306, "database": "myapp", "auth": { "method": "PASSWORD", "username": "deploy_user", "password": "secured" } } ] } }, "PostgreSQL CLI (POSTGRESQL_CLI)": { "description": "PostgreSQL CLI (POSTGRESQL_CLI)", "value": { "name": "Run PostgreSQL queries", "type": "POSTGRESQL_CLI", "trigger_time": "ON_EVERY_EXECUTION", "version": "16", "shell": "BASH", "execute_commands": [ "psql -c '\\l'", "psql -f migrate.sql" ], "targets": [ { "identifier": "my_database", "name": "My PostgreSQL Database", "type": "POSTGRESQL", "scope": "ACTION", "host": "pg.example.com", "port": 5432, "database": "myapp", "auth": { "method": "PASSWORD", "username": "deploy_user", "password": "secured" } } ] } }, "Mongosh CLI (MONGOSH_CLI)": { "description": "Mongosh CLI (MONGOSH_CLI)", "value": { "name": "Run MongoDB queries", "type": "MONGOSH_CLI", "trigger_time": "ON_EVERY_EXECUTION", "version": "8.0", "shell": "BASH", "execute_commands": [ "mongosh --quiet \"$MONGOSH_URI\" --eval 'db.stats()'", "mongosh --quiet \"$MONGOSH_URI\" script.js" ], "targets": [ { "identifier": "my_mongo", "type": "MONGO", "scope": "ACTION", "host": "mongo.example.com", "database": "myapp", "auth_source": "admin", "auth": { "method": "PASSWORD", "username": "user", "password": "pass" } } ] } }, "MSSQL CLI (MSSQL_CLI)": { "description": "MSSQL CLI (MSSQL_CLI)", "value": { "name": "Run MSSQL queries", "type": "MSSQL_CLI", "trigger_time": "ON_EVERY_EXECUTION", "shell": "BASH", "execute_commands": [ "sqlcmd -Q 'SELECT @@VERSION'", "sqlcmd -i migrate.sql" ], "targets": [ { "identifier": "my_mssql_database", "name": "My MSSQL Database", "type": "MSSQL", "scope": "ACTION", "host": "mssql.example.com", "port": "1433", "database": "app", "auth": { "method": "PASSWORD", "username": "app_user", "password": "secured" } } ] } }, "GKE Run Helm (HELM)": { "description": "GKE Run Helm (HELM)", "value": { "name": "K8s Helm", "disabled": true, "type": "HELM", "trigger_time": "ON_EVERY_EXECUTION", "trigger_conditions": [ { "trigger_condition": "ON_CHANGE" }, { "trigger_condition": "HOUR", "trigger_hours": [ 8, 9, 10 ], "timezone": "Europe/Warsaw" } ], "targets": [ { "role_arn": "arn:aws:iam::123456789012:role/eks-cluster-service-role", "region": "eu-central-1", "identifier": "my_target_id", "name": "my-target", "integration": "hiqfilrcfx", "type": "EKS", "scope": "ACTION", "tags": [ "olive", "orange", "rabsperry" ], "cluster": "https://192.168.5.226:6443" } ], "helm_repository_integration": { "identifier": "aws" }, "helm_repository_region": "us-west-2", "execute_commands": [ "kubectl get namespaces -o=custom-columns=NAME:.metadata.name", "cat ~/.kube/config" ], "setup_commands": [ "helm plugin install https://github.com/hypnoglow/helm-s3.git --version 0.7.0", "helm plugin install https://github.com/hayorov/helm-gcs --version 0.2.1" ], "helm_version": "v3.10.2", "variables": [ { "key": "env_key", "value": "env_value", "type": "VAR", "settable": false, "run_only_settable": false, "encrypted": false, "description": "twcksymvsi" } ], "shell": "BASH", "kubectl_version": "latest", "timeout": 1800, "retry_interval": 60, "retry_count": 5, "ignore_errors": true, "current_revision": "21825f31ddce8a89b3ed9f4c92f038b339cde150", "loop": [ "env_key" ] } }, "ZIP (ZIP)": { "description": "ZIP (ZIP)", "value": { "name": "Zippy zip", "type": "ZIP", "trigger_time": "ON_EVERY_EXECUTION", "local_path": "/dir_to_zip", "destination": "artifact.zip", "deployment_excludes": [ "/tmp/", "*.log" ], "deployment_includes": [ "/assets/style", "/tmp/file.txt" ] } }, "Eslint (ESLINT) ⚠️ DEPRECATED": { "description": "Eslint (ESLINT) ⚠️ DEPRECATED", "value": { "name": "ESLint analyse", "type": "ESLINT", "trigger_time": "ON_EVERY_EXECUTION", "version": "9.4.0", "style": "airbnb", "fix": true, "quiet": true } }, "Sign Android Application (ANDROID_SIGN)": { "description": "Sign Android Application (ANDROID_SIGN)", "value": { "name": "Sign Android App", "type": "ANDROID_SIGN", "trigger_time": "ON_EVERY_EXECUTION", "local_path": "my-app-unsigned-aligned.apk", "output_dir": "out", "application_name": "my-app-release.apk", "key_path": "my-release-key.jks", "key_alias": "", "key_password": "${key_password}", "keystore_password": "${keystore_password}", "build_tool_version": "26.0.2" } }, "Sign Bundle (ANDROID_SIGN_BUNDLE)": { "description": "Sign Bundle (ANDROID_SIGN_BUNDLE)", "value": { "name": "Sign Android bundle", "type": "ANDROID_SIGN_BUNDLE", "trigger_time": "ON_EVERY_EXECUTION", "local_path": "app/build/outputs/bundle/release/app-release.aab", "output_dir": "/", "application_name": "app-release-signed.aab", "key_path": "my-release-key.jks", "key_alias": "", "key_password": "${key_password}", "keystore_password": "${keystore_password}" } }, "Publish Android Application (ANDROID_PUBLISH_APK)": { "description": "Publish Android Application (ANDROID_PUBLISH_APK)", "value": { "name": "Publish Android App", "type": "ANDROID_PUBLISH_APK", "trigger_time": "ON_EVERY_EXECUTION", "application_id": "com.mycompany.mylovelyapp", "track": "alpha", "user_fraction": 0.05, "mapping_path": "", "changes_path": "changes.xml", "supersede_versions": true, "draft": true, "variables": [ { "key": "apkPath", "value": "my-app-release9.apk" } ], "apk_files": [ { "apk_path": "$apkPath", "main_expansion_path": "ss", "patch_expansion_path": "" } ], "integration": { "identifier": "google-play" } } }, "Upload APK to Google Play (ANDROID_PLAY) ⚠️ DEPRECATED": { "description": "Upload APK to Google Play (ANDROID_PLAY) ⚠️ DEPRECATED", "value": { "name": "Upload APK to Google Play", "type": "ANDROID_PLAY", "trigger_time": "ON_EVERY_EXECUTION", "application_id": "com.mycompany.mylovelyapp", "track": "production", "user_fraction": 0.1, "mapping_path": "app/build/outputs/mapping/release/mapping.txt", "changes_path": "release-notes.xml", "supersede_versions": false, "draft": false, "changes_not_sent_for_review": false, "apk_files": [ { "apk_path": "app/build/outputs/apk/release/app-release.apk", "main_expansion_path": "", "patch_expansion_path": "" } ], "key_path": "google-play-key.json", "integration": { "identifier": "google-play" } } }, "Publish Android App Bundle (ANDROID_PUBLISH_APP_BUNDLE)": { "description": "Publish Android App Bundle (ANDROID_PUBLISH_APP_BUNDLE)", "value": { "name": "Publish Android App Bundle", "disabled": true, "type": "ANDROID_PUBLISH_APP_BUNDLE", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "euyxwcxbtr", "name": "slskopytko", "type": "GOOGLE_PLAY_STORE", "scope": "WORKSPACE" }, "application_id": "artifact-name", "variables": [ { "key": "env_key", "value": "env_value", "type": "VAR", "settable": false, "run_only_settable": false, "encrypted": false, "description": "popbtdrugc" } ], "track": "rollout", "user_fraction": 0.1, "changes_path": "/assets/Controller.php", "supersede_versions": true, "apk_files": [ { "apk_path": "bundle", "main_expansion_path": "main-file", "patch_expansion_path": "patch-file" } ], "draft": true, "timeout": 1800, "retry_interval": 60, "retry_count": 5, "ignore_errors": true, "current_revision": "21825f31ddce8a89b3ed9f4c92f038b339cde150", "loop": [ "env_key" ] } }, "Upload Bundle to Google Play (ANDROID_PLAY_BUNDLE) ⚠️ DEPRECATED": { "description": "Upload Bundle to Google Play (ANDROID_PLAY_BUNDLE) ⚠️ DEPRECATED", "value": { "name": "Upload Bundle to Google Play", "type": "ANDROID_PLAY_BUNDLE", "trigger_time": "ON_EVERY_EXECUTION", "application_id": "com.mycompany.mylovelyapp", "track": "internal", "user_fraction": 1, "changes_path": "release-notes.xml", "supersede_versions": true, "draft": true, "changes_not_sent_for_review": false, "apk_files": [ { "apk_path": "app/build/outputs/bundle/release/app-release.aab" } ], "key_path": "google-play-key.json", "integration": { "identifier": "google-play" } } }, "Firebase (FIREBASE)": { "description": "Firebase (FIREBASE)", "value": { "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": { "identifier": "firebase" } } }, "Netlify (NETLIFY)": { "description": "Netlify (NETLIFY)", "value": { "name": "Deploy to apk-42707", "type": "NETLIFY", "trigger_time": "ON_EVERY_EXECUTION", "shell": "SH", "site_id": "70225fg3-9sc1-17c6-98dc-ef367123f12d9", "setup_commands": [ "apt-get update && apt-get -y install git" ], "execute_commands": [ "netlify deploy --dir=${netlify_dir}" ], "variables": [ { "key": "netlify_dir", "value": "directory_name" } ], "integration": { "identifier": "netlify" } } }, "Lighthouse (LIGHTHOUSE)": { "description": "Lighthouse (LIGHTHOUSE)", "value": { "name": "Lighthouse", "type": "LIGHTHOUSE", "trigger_time": "ON_EVERY_EXECUTION", "device": "mobile", "website": "https://buddy.works", "performance": 50, "accessibility": 50, "best_practices": 50, "seo": 50 } }, "Replace (REPLACE)": { "description": "Replace (REPLACE)", "value": { "name": "Replace values", "type": "REPLACE", "trigger_time": "ON_EVERY_EXECUTION", "local_path": "/", "replacements": [ { "replace_from": "[ENV]", "replace_to": "stage" }, { "replace_from": "multiline", "replace_to": "Replace\nmultiline\nstring" } ] } }, "Gitcrypt unlock (GIT_CRYPT_UNLOCK)": { "description": "Gitcrypt unlock (GIT_CRYPT_UNLOCK)", "value": { "name": "Gitcrypt unlock", "type": "GIT_CRYPT_UNLOCK", "trigger_time": "ON_EVERY_EXECUTION", "keys": [ { "name": "default", "content": "secure!e5ToPs3ggT/W0sdRwV3Jn7qvJzS4Fl4D7I/BHY23P57EH04XExkZoYPjIC6/ETXnT86BbAOjwHFhuHtg3caXASCuAeD3cdSaQ8oJhBGii7MVXU9ErExHS9un0uJUHvLQo3JD6+sHf6QBYCJ3QFY/oNG+qL" } ] } }, "Gitcrypt lock (GIT_CRYPT_LOCK)": { "description": "Gitcrypt lock (GIT_CRYPT_LOCK)", "value": { "name": "Gitcrypt lock", "type": "GIT_CRYPT_LOCK", "trigger_time": "ON_EVERY_EXECUTION", "keys": [ { "name": "default", "content": "secure!e5ToPs3ggT/W0sdRwV3Jn7qvJzS4Fl4D7I/BHY23P57EH04XExkZoYPjIC6/ETXnT86BbAOjwHFhuHtg3caXASCuAeD3cdSaQ8oJhBGii7MVXU9ErExHS9un0uJUHvLQo3JD6+sHf6QBYCJ3QFY/oNG+qL" } ] } }, "Split Tests (SPLIT_TESTS)": { "description": "Split Tests (SPLIT_TESTS)", "value": { "name": "Split Tests", "type": "SPLIT_TESTS", "trigger_time": "ON_EVERY_EXECUTION", "source_path": "/tests/", "groups_count": 4, "files_order": "BY_FILE_SIZE" } }, "Compress images (IMAGE_COMPRESSION)": { "description": "Compress images (IMAGE_COMPRESSION)", "value": { "name": "Compress images", "type": "IMAGE_COMPRESSION", "trigger_time": "ON_EVERY_EXECUTION", "local_path": "/local", "destination": "/destination", "level": "1", "types": "jpg,png,gif,svg" } }, "Dockerfile Linter (DOCKERFILE_LINTER)": { "description": "Dockerfile Linter (DOCKERFILE_LINTER)", "value": { "name": "linter", "type": "DOCKERFILE_LINTER", "trigger_time": "ON_EVERY_EXECUTION", "local_path": "Dockerfile", "shell_type": "bash", "ignore_codes": "ER0012,ER0015,SC1017,SC2020", "ignores_path": "ignores.yaml" } }, "Download (DOWNLOAD)": { "description": "Download (DOWNLOAD)", "value": { "name": "Download files from FTP server", "type": "DOWNLOAD", "trigger_time": "ON_EVERY_EXECUTION", "source_path": "/source", "recursive": false, "targets": [ { "type": "FTP", "secure": false, "identifier": "ftp_target_1", "host": "192.0.2.1", "port": "21", "auth": { "username": "user", "password": "secure!gYTKjljwPt4nAffHn6mGEQ==.5rkCAHX55eiwOqJ73oGg6g==" }, "path": "/var/www" } ], "destination_path": "/assets", "overwrite": false } }, "Download S3 (DOWNLOAD_S3)": { "description": "Download S3 (DOWNLOAD_S3)", "value": { "name": "Download files from AWS S3/", "type": "DOWNLOAD_S3", "trigger_time": "ON_EVERY_EXECUTION", "bucket_name": "bucketname", "source_path": "source", "destination_path": "destination", "integration": { "identifier": "aws" }, "overwrite": true, "recursive": true, "download_excludes": [ "/tmp", "*.log" ], "download_includes": [ "/tmp/assets", "/tmp/styles" ] } }, "Download from Sandbox (DOWNLOAD_FROM_SANDBOX) ⚠️ DEPRECATED": { "description": "Download from Sandbox (DOWNLOAD_FROM_SANDBOX) ⚠️ DEPRECATED", "value": { "name": "Download Test Results", "type": "DOWNLOAD_FROM_SANDBOX", "trigger_time": "ON_EVERY_EXECUTION", "sandbox_id": "ghwmnj2az2k67", "sandbox_references": [ "BY_ID" ], "source_path": "/var/test-results", "destination_path": "/test-reports", "recursive": true, "overwrite": true, "user": "testrunner", "download_excludes": [ "*.tmp", "cache/*" ], "download_includes": [ "**/*.xml", "**/*.html" ] } }, "Download GCS (DOWNLOAD_GCS)": { "description": "Download GCS (DOWNLOAD_GCS)", "value": { "name": "Download files from GCS", "type": "DOWNLOAD_GCS", "trigger_time": "ON_EVERY_EXECUTION", "bucket_name": "bucketname", "source_path": "source", "destination_path": "destination", "integration": { "identifier": "gcp" }, "overwrite": true, "recursive": true, "download_excludes": [ "/tmp", "*.log" ], "download_includes": [ "/tmp/assets", "/tmp/styles" ], "application_name": "hello-world" } }, "Download Backblaze B2 (DOWNLOAD_BACKBLAZE_B2)": { "description": "Download Backblaze B2 (DOWNLOAD_BACKBLAZE_B2)", "value": { "name": "Download files from Backblaze B2/bucketname", "type": "DOWNLOAD_BACKBLAZE_B2", "trigger_time": "ON_EVERY_EXECUTION", "bucket_name": "bucketname", "source_path": "source", "destination_path": "destination", "integration": { "identifier": "backblaze" }, "region": "us-east-005", "overwrite": true, "recursive": true, "download_excludes": [ "/tmp", "*.log" ], "download_includes": [ "/tmp/assets", "/tmp/styles" ] } }, "Download Artifact (DOWNLOAD_ARTIFACT_VERSION)": { "description": "Download Artifact (DOWNLOAD_ARTIFACT_VERSION)", "value": { "name": "Download files from Artifact", "disabled": true, "type": "DOWNLOAD_ARTIFACT_VERSION", "trigger_time": "ON_EVERY_EXECUTION", "source_path": "target/path/on/server", "recursive": true, "version": "1.0.0", "destination_path": "/assets/", "overwrite": true, "variables": [ { "key": "env_key", "value": "env_value", "type": "VAR", "settable": false, "run_only_settable": false, "encrypted": false, "description": "nkrttlwhfx" } ], "timeout": 1800, "retry_interval": 60, "retry_count": 5, "ignore_errors": true, "download_excludes": [ "/ignorePath", "/ignore/path/2" ], "download_includes": [ "/excludePath", "/exclude/path/2" ], "current_revision": "21825f31ddce8a89b3ed9f4c92f038b339cde150", "artifact": "buddytests", "loop": [ "env_key" ] } }, "Create new sandbox (SANDBOX_CREATE)": { "description": "Create new sandbox (SANDBOX_CREATE)", "value": { "name": "Create sandbox", "disabled": true, "type": "SANDBOX_CREATE", "trigger_time": "ON_EVERY_EXECUTION", "timeout": 1800, "retry_interval": 60, "retry_count": 5, "ignore_errors": true, "current_revision": "21825f31ddce8a89b3ed9f4c92f038b339cde150", "from": "SCRATCH", "update_if_exists": true, "start": false, "spec": { "name": "Running", "identifier": "running", "os": "ubuntu:24.04", "resources": "3x6", "first_boot_commands": "apt-get update\napt-get install -y nginx", "tags": [ "azure", "purple" ], "apps": [ "nginx -t" ], "app_dir": "/var/www/html", "endpoints": [ { "name": "buddy-graigmaribelesposito-dev-tcp", "endpoint": "localhost:22", "domain": "agent-dev.net", "subdomain": null, "region": "EU", "type": "TCP", "timeout": 60, "whitelist": [ "12.34.56.78" ] } ] }, "loop": [ "env_key" ] } }, "Clone Sandbox (SANDBOX_CREATE_FROM_SANDBOX)": { "description": "Clone Sandbox (SANDBOX_CREATE_FROM_SANDBOX)", "value": { "name": "staging-clone-001", "type": "SANDBOX_CREATE_FROM_SANDBOX", "trigger_time": "ON_EVERY_EXECUTION", "sandbox_name": "staging-clone-001", "referenced_sandbox_name": "prod-sandbox-001", "sandbox_distribution": "ubuntu:22.04", "resources": "2x4", "return_existing": false, "tags": [ "staging", "clone" ] } }, "Create Sandbox from Snapshot (SANDBOX_CREATE_FROM_SNAPSHOT)": { "description": "Create Sandbox from Snapshot (SANDBOX_CREATE_FROM_SNAPSHOT)", "value": { "name": "restored-environment", "type": "SANDBOX_CREATE_FROM_SNAPSHOT", "trigger_time": "ON_EVERY_EXECUTION", "sandbox_name": "restored-environment", "snapshot_id": "snapshot-20250107", "sandbox_distribution": "ubuntu:22.04", "resources": "4x8", "return_existing": false, "tags": [ "restored", "backup" ] } }, "Manage sandbox (SANDBOX_MANAGE)": { "description": "Manage sandbox (SANDBOX_MANAGE)", "value": { "name": "Start sandbox app", "type": "SANDBOX_MANAGE", "trigger_time": "ON_EVERY_EXECUTION", "disabled": false, "operation": "APP_START", "targets": [ { "identifier": "create-sb", "scope": "ANY", "type": "MATCH" } ], "ignore_errors": false, "run_next_parallel": false } }, "Start Sandbox App (SANDBOX_APPLICATION_START)": { "description": "Start Sandbox App (SANDBOX_APPLICATION_START)", "value": { "name": "Start Web Server", "type": "SANDBOX_APPLICATION_START", "trigger_time": "ON_EVERY_EXECUTION", "sandbox_id": "ghwmnj2az2k67", "sandbox_references": [ "BY_ID" ] } }, "Stop Sandbox App (SANDBOX_APPLICATION_STOP)": { "description": "Stop Sandbox App (SANDBOX_APPLICATION_STOP)", "value": { "name": "Stop Web Server", "type": "SANDBOX_APPLICATION_STOP", "trigger_time": "ON_EVERY_EXECUTION", "sandbox_id": "ghwmnj2az2k67", "sandbox_references": [ "BY_ID" ] } }, "Start Sandbox (SANDBOX_START) ⚠️ DEPRECATED": { "description": "Start Sandbox (SANDBOX_START) ⚠️ DEPRECATED", "value": { "name": "Start Development Sandbox", "type": "SANDBOX_START", "trigger_time": "ON_EVERY_EXECUTION", "sandbox_id": "ghwmnj2az2k67", "sandbox_references": [ "BY_ID" ], "tags": [ "development" ] } }, "Stop Sandbox (SANDBOX_STOP) ⚠️ DEPRECATED": { "description": "Stop Sandbox (SANDBOX_STOP) ⚠️ DEPRECATED", "value": { "name": "Stop Development Sandbox", "type": "SANDBOX_STOP", "trigger_time": "ON_EVERY_EXECUTION", "sandbox_id": "ghwmnj2az2k67", "sandbox_references": [ "BY_ID" ], "tags": [ "development" ] } }, "Create New Sandbox (SANDBOX_CREATE_NEW) ⚠️ DEPRECATED": { "description": "Create New Sandbox (SANDBOX_CREATE_NEW) ⚠️ DEPRECATED", "value": { "name": "Create Test Environment", "type": "SANDBOX_CREATE_NEW", "trigger_time": "ON_EVERY_EXECUTION", "sandbox_name": "test-env-pr-456", "sandbox_distribution": "ubuntu:22.04", "resources": "2x4", "return_existing": false, "sandbox_project_id": 789, "tags": [ "test", "pr-456" ] } }, "Create Sandbox Snapshot (SANDBOX_SNAPSHOT) ⚠️ DEPRECATED": { "description": "Create Sandbox Snapshot (SANDBOX_SNAPSHOT) ⚠️ DEPRECATED", "value": { "name": "Backup Before Deployment", "type": "SANDBOX_SNAPSHOT", "trigger_time": "ON_EVERY_EXECUTION", "sandbox_id": "ghwmnj2az2k67", "sandbox_references": [ "BY_ID" ], "snapshot_name": "pre-deployment-v2.5.0" } }, "Delete Sandbox (SANDBOX_DELETE) ⚠️ DEPRECATED": { "description": "Delete Sandbox (SANDBOX_DELETE) ⚠️ DEPRECATED", "value": { "name": "Cleanup Test Environment", "type": "SANDBOX_DELETE", "trigger_time": "ON_EVERY_EXECUTION", "sandbox_id": "test-env-pr-456", "sandbox_references": [ "BY_ID" ] } }, "Validate Website Links (LINK_VALIDATOR) ⚠️ DEPRECATED": { "description": "Validate Website Links (LINK_VALIDATOR) ⚠️ DEPRECATED", "value": { "name": "Check Website Links", "type": "LINK_VALIDATOR", "trigger_time": "ON_EVERY_EXECUTION", "website": "https://www.example.com", "depth": 3, "ignored_prefixes": [ "https://external-tracker.com", "https://analytics.google.com", "mailto:" ], "ignore_errors": false, "timeout": 600 } }, "Link Checker (LINK_CHECKER)": { "description": "Link Checker (LINK_CHECKER)", "value": { "name": "Link checker", "type": "LINK_CHECKER", "trigger_time": "ON_EVERY_EXECUTION", "ba_username": "basicAuthUsername", "ba_password": "secure!ucaApNnkABxsQuyAQJ4sXQ==.QPJaybamhxXg2j9ICwoSKw==", "html_form_auth_username": "htmlFormAuthUsername", "html_form_auth_password": "secure!ucaApNnkABxsQuyAQJ4sXQ==.QPJaybamhxXg2j9ICwoSKw==", "html_form_auth_username_input_name": "htmlFormAuthUsernameInput", "html_form_auth_password_input_name": "htmlFormAuthPasswordInput", "html_form_auth_url": "https://linktocheck.com", "depth": 1, "scan_url": "https://linktocheck.com", "cookies": [ { "name": "header", "value": "value" } ], "threads": 5, "connection_timeout": 11, "requests_per_host": 5, "respect_robot_exclusions": false, "check_ssl_certificate": true, "internal_links": "Scan_url/*", "check_external_links": true, "ignore_urls": [ "https://example.com/.*" ], "no_follow_urls": [ "https://example.com/.*" ], "warning_regex": "(This page has moved|Oracle Application error)" } }, "Azure CLI (AZURE_CLI)": { "description": "Azure CLI (AZURE_CLI)", "value": { "name": "Azure Cli", "type": "AZURE_CLI", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "azure" }, "setup_commands": [ "apt-get update && apt-get -y install git" ], "execute_commands": [ "az webapp list" ], "shell": "SH" } }, "Theme Kit CLI (SHOPIFY_THEMEKIT_CLI)": { "description": "Theme Kit CLI (SHOPIFY_THEMEKIT_CLI)", "value": { "name": "Shopify theme", "type": "SHOPIFY_THEMEKIT_CLI", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "shopify" }, "setup_commands": [ "apt-get update && apt-get -y install git" ], "execute_commands": [ "theme deploy" ], "shell": "SH" } }, "Shopify CLI (SHOPIFY_CLI)": { "description": "Shopify CLI (SHOPIFY_CLI)", "value": { "name": "Shopify", "type": "SHOPIFY_CLI", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "shopify" }, "setup_commands": [ "apt-get update && apt-get -y install git" ], "execute_commands": [ "shopify theme push --theme your_theme_name --store=your_store_url" ], "shell": "SH" } }, "SSL verify (SSL_VERIFY)": { "description": "SSL verify (SSL_VERIFY)", "value": { "name": "SSL VERIFY", "port": "443", "type": "SSL_VERIFY", "trigger_time": "ON_EVERY_EXECUTION", "website": "buddy.works", "valid_for_days": 31 } }, "GitHub Release (GIT_HUB_RELEASE)": { "description": "GitHub Release (GIT_HUB_RELEASE)", "value": { "name": "Make GitHub Release", "type": "GIT_HUB_RELEASE", "trigger_time": "ON_EVERY_EXECUTION", "draft": true, "tag_name": "$BUDDY_RUN_ID", "target_commitish": "$BUDDY_RUN_COMMIT", "release_name": "app release", "body": "body", "prerelease": true, "zip_assets": false, "external_project_id": "buddy/repo-tests", "organization": "buddy", "assets": [ { "source_path": "assets", "label": "labelName" } ], "integration": { "identifier": "github" } } }, "Windows (NATIVE_BUILD_WINDOWS)": { "description": "Windows (NATIVE_BUILD_WINDOWS)", "value": { "name": "Execute: msbuild", "type": "NATIVE_BUILD_WINDOWS", "trigger_time": "ON_EVERY_EXECUTION", "working_directory": "c:\\windows", "commands": [ "nuget restore", "msbuild" ], "execute_every_command": true, "distribution": "AMI", "ami": { "id": "ami-00bf6b81ba0081ada", "password": "pass-to-admin" }, "sync_paths": [ { "pipeline_path": "/", "vm_path": "c:\\buddy", "direction": "PIPELINE_TO_VM" }, { "pipeline_path": "/", "vm_path": "c:\\buddy", "direction": "VM_TO_PIPELINE" } ] } }, "Xcode (NATIVE_BUILD_MAC)": { "description": "Xcode (NATIVE_BUILD_MAC)", "value": { "name": "Build application", "type": "NATIVE_BUILD_MAC", "trigger_time": "ON_EVERY_EXECUTION", "working_directory": "/Users/buddy/build", "commands": [ "ls" ], "execute_every_command": true, "sync_paths": [ { "pipeline_path": "/", "vm_path": "/Users/buddy/build", "direction": "PIPELINE_TO_VM" }, { "pipeline_path": "/", "vm_path": "/Users/buddy/build", "direction": "VM_TO_PIPELINE" } ], "xcode_version": "13", "pre_start_simulators": [ "iPhone 13 Pro Max" ], "certificates": [ "myCert" ], "provision_profiles": [ "myProfile" ] } }, "MacOS VM (NATIVE_BUILD_MAC_VM)": { "description": "MacOS VM (NATIVE_BUILD_MAC_VM)", "value": { "name": "Build iOS App on macOS VM", "type": "NATIVE_BUILD_MAC_VM", "trigger_time": "ON_EVERY_EXECUTION", "working_directory": "/", "commands": [ "xcodebuild clean", "xcodebuild -workspace MyApp.xcworkspace -scheme MyApp -configuration Release archive -archivePath ./build/MyApp.xcarchive" ], "execute_every_command": true, "xcode_version": "15.2", "node_version": "20.10.0", "shell": "BASH", "sync_paths": [ { "pipeline_path": "/workspace", "vm_path": "/Users/builder/project", "direction": "PIPELINE_TO_VM", "excludes": "*.log", "includes": "" }, { "pipeline_path": "/artifacts", "vm_path": "/Users/builder/project/build", "direction": "VM_TO_PIPELINE", "excludes": "", "includes": "*.ipa" } ], "certificates": [ "$IOS_DISTRIBUTION_CERT" ], "provision_profiles": [ "$IOS_PROVISIONING_PROFILE" ] } }, "Build a React Native App (NATIVE_BUILD_MAC_REACT)": { "description": "Build a React Native App (NATIVE_BUILD_MAC_REACT)", "value": { "name": "Build application", "type": "NATIVE_BUILD_MAC_REACT", "trigger_time": "ON_EVERY_EXECUTION", "working_directory": "/Users/buddy/build", "commands": [ "ls" ], "execute_every_command": true, "sync_paths": [ { "pipeline_path": "/", "vm_path": "/Users/buddy/build", "direction": "PIPELINE_TO_VM" }, { "pipeline_path": "/", "vm_path": "/Users/buddy/build", "direction": "VM_TO_PIPELINE" } ], "node_version": "14", "xcode_version": "13", "pre_start_simulators": [ "iPhone 13 Pro Max" ], "certificates": [ "myCert" ], "provision_profiles": [ "myProfile" ] } }, "Build a Cordova App (NATIVE_BUILD_MAC_CORDOVA)": { "description": "Build a Cordova App (NATIVE_BUILD_MAC_CORDOVA)", "value": { "name": "Build application", "type": "NATIVE_BUILD_MAC_CORDOVA", "trigger_time": "ON_EVERY_EXECUTION", "working_directory": "/Users/buddy/build", "commands": [ "cordova build ios" ], "execute_every_command": true, "sync_paths": [ { "pipeline_path": "/", "vm_path": "/Users/buddy/build", "direction": "PIPELINE_TO_VM" }, { "pipeline_path": "/", "vm_path": "/Users/buddy/build", "direction": "VM_TO_PIPELINE" } ], "node_version": "14", "xcode_version": "13", "pre_start_simulators": [ "iPhone 13 Pro Max" ], "certificates": [ "myCert" ], "provision_profiles": [ "myProfile" ] } }, "Build a Fastlane App (NATIVE_BUILD_MAC_FASTLANE)": { "description": "Build a Fastlane App (NATIVE_BUILD_MAC_FASTLANE)", "value": { "name": "Build application", "type": "NATIVE_BUILD_MAC_FASTLANE", "trigger_time": "ON_EVERY_EXECUTION", "working_directory": "/Users/buddy/build", "commands": [ "fastlane snapshot" ], "execute_every_command": true, "sync_paths": [ { "pipeline_path": "/", "vm_path": "/Users/buddy/build", "direction": "PIPELINE_TO_VM" }, { "pipeline_path": "/", "vm_path": "/Users/buddy/build", "direction": "VM_TO_PIPELINE" } ], "node_version": "14", "xcode_version": "13", "pre_start_simulators": [ "iPhone 13 Pro Max" ], "certificates": [ "myCert" ], "provision_profiles": [ "myProfile" ] } }, "Build a Flutter App (NATIVE_BUILD_MAC_FLUTTER)": { "description": "Build a Flutter App (NATIVE_BUILD_MAC_FLUTTER)", "value": { "name": "Build application", "type": "NATIVE_BUILD_MAC_FLUTTER", "trigger_time": "ON_EVERY_EXECUTION", "working_directory": "/Users/buddy/build", "commands": [ "flutter build ios --release" ], "execute_every_command": true, "sync_paths": [ { "pipeline_path": "/", "vm_path": "/Users/buddy/build", "direction": "PIPELINE_TO_VM" }, { "pipeline_path": "/", "vm_path": "/Users/buddy/build", "direction": "VM_TO_PIPELINE" } ], "node_version": "14", "xcode_version": "13", "pre_start_simulators": [ "iPhone 13 Pro Max" ], "certificates": [ "myCert" ], "provision_profiles": [ "myProfile" ] } }, "Code sign and export an iOS app (NATIVE_BUILD_MAC_SIGN)": { "description": "Code sign and export an iOS app (NATIVE_BUILD_MAC_SIGN)", "value": { "name": "Sign and export", "type": "NATIVE_BUILD_MAC_SIGN", "trigger_time": "ON_EVERY_EXECUTION", "export_location": "/", "distribution_method": "APP_STORE", "property_list_source": "ACTION", "property_list": "list", "certificates": [ "myCert" ], "provision_profiles": [ "myProvisionProfile" ] } }, "Deploy to App Store Connect (NATIVE_BUILD_MAC_DEPLOY)": { "description": "Deploy to App Store Connect (NATIVE_BUILD_MAC_DEPLOY)", "value": { "name": "Deploy to App Store Connect", "type": "NATIVE_BUILD_MAC_DEPLOY", "trigger_time": "ON_EVERY_EXECUTION", "archive_location": "$BUDDY_SIGNED_IPA_PATH", "validate_before_upload": true, "submit_for_review": true, "skip_metadata": true, "skip_app_version_update": true, "skip_screenshots": true, "integration": { "identifier": "appstore-connect" } } }, "Docker CLI (NATIVE_BUILD_DOCKER_CLI)": { "description": "Docker CLI (NATIVE_BUILD_DOCKER_CLI)", "value": { "name": "Execute: docker --version", "type": "NATIVE_BUILD_DOCKER_CLI", "trigger_time": "ON_EVERY_EXECUTION", "working_directory": "/home/ubuntu/build", "commands": [ "docker --version" ], "execute_every_command": true, "sync_paths": [ { "pipeline_path": "/", "vm_path": "/home/ubuntu/build", "direction": "PIPELINE_TO_VM", "excludes": "/.git" }, { "pipeline_path": "/", "vm_path": "/home/ubuntu/build", "direction": "VM_TO_PIPELINE", "excludes": "" } ], "vm_from_prev_action": true, "vm_action_name": "Build action" } }, "Linux (NATIVE_BUILD_LINUX)": { "description": "Linux (NATIVE_BUILD_LINUX)", "value": { "name": "Build application", "type": "NATIVE_BUILD_LINUX", "trigger_time": "ON_EVERY_EXECUTION", "working_directory": "/home/ubuntu/build", "commands": [ "ls -al" ], "distribution": "AMI", "ami": { "id": "ami-00bf6b81ba0081ada", "user": "ubuntu", "port": "22" }, "sync_paths": [ { "pipeline_path": "/", "vm_path": "/home/ubuntu/build", "direction": "PIPELINE_TO_VM", "excludes": "/.git" }, { "pipeline_path": "/", "vm_path": "/home/ubuntu/build", "direction": "VM_TO_PIPELINE", "excludes": "" } ] } }, "DigitalOcean CLI (DOCTL)": { "description": "DigitalOcean CLI (DOCTL)", "value": { "name": "Execute: doctl account get", "type": "DOCTL", "trigger_time": "ON_EVERY_EXECUTION", "execute_commands": [ "doctl account get" ], "shell": "SH", "integration": { "identifier": "digitalocean" } } }, "Clear Cache (CLEAR_CACHE)": { "description": "Clear Cache (CLEAR_CACHE)", "value": { "name": "Clear cache", "type": "CLEAR_CACHE", "trigger_time": "ON_EVERY_EXECUTION", "cache_types": [ "DOCKER", "FILE_SYSTEM", "SERVICES", "ADDITIONAL" ] } }, "Fastlane for Android (FASTLANE_ANDROID)": { "description": "Fastlane for Android (FASTLANE_ANDROID)", "value": { "name": "Build Android with Fastlane", "type": "FASTLANE_ANDROID", "trigger_time": "ON_EVERY_EXECUTION", "build_tool_version": "34.0.0", "shell": "BASH", "setup_commands": [ "bundle install", "fastlane update_plugins" ], "execute_commands": [ "fastlane android beta" ], "execute_every_command": true, "variables": [ { "key": "ANDROID_HOME", "value": "/opt/android-sdk" } ] } }, "GitHub CLI (GIT_HUB_CLI)": { "description": "GitHub CLI (GIT_HUB_CLI)", "value": { "name": "Run GitHub CLI command", "type": "GIT_HUB_CLI", "trigger_time": "ON_EVERY_EXECUTION", "setup_commands": [ "apt-get update && apt-get -y install git" ], "execute_commands": [ "gh repo list" ], "shell": "BASH", "variables": [ { "key": "command", "value": "list-functions" } ], "integration": { "identifier": "github" } } }, "GitLab CLI (GIT_LAB_CLI)": { "description": "GitLab CLI (GIT_LAB_CLI)", "value": { "name": "Run GitLab CLI command", "type": "GIT_LAB_CLI", "trigger_time": "ON_EVERY_EXECUTION", "setup_commands": [ "apt-get update && apt-get -y install git" ], "execute_commands": [ "glab auth status" ], "shell": "BASH", "integration": { "identifier": "gitlab" } } }, "Generate variables (INTEGRATION_VARIABLES)": { "description": "Generate variables (INTEGRATION_VARIABLES)", "value": { "name": "Generate variables from an integration", "type": "INTEGRATION_VARIABLES", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "sample-integration" } } }, "AWS CodePipeline (CODE_PIPELINE)": { "description": "AWS CodePipeline (CODE_PIPELINE)", "value": { "name": "Trigger AWS CodePipeline", "type": "CODE_PIPELINE", "region": "us-west-2", "code_pipeline_name": "my_codepipeline_name", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "aws" } } }, "AWS CDK CLI (AWS_CDK_CLI)": { "description": "AWS CDK CLI (AWS_CDK_CLI)", "value": { "name": "Run AWS CDK commands", "type": "AWS_CDK_CLI", "trigger_time": "ON_EVERY_EXECUTION", "setup_commands": [ "apt-get update && apt-get -y install git" ], "execute_commands": [ "cdk --version" ], "shell": "SH", "integration": { "identifier": "aws" }, "region": "us-west-2" } }, "Ghost Inspector CLI (GHOST_INSPECTOR_CLI)": { "description": "Ghost Inspector CLI (GHOST_INSPECTOR_CLI)", "value": { "name": "Run Ghost Inspector CLI", "type": "GHOST_INSPECTOR_CLI", "trigger_time": "ON_EVERY_EXECUTION", "setup_commands": [ "apt-get update && apt-get -y install git" ], "execute_commands": [ "ghost-inspector suite list-tests " ], "shell": "SH", "integration": { "identifier": "ghost-inspector" } } }, "Terraform CLI (TERRAFORM)": { "description": "Terraform CLI (TERRAFORM)", "value": { "name": "Run Terraform commands", "type": "TERRAFORM", "trigger_time": "ON_EVERY_EXECUTION", "setup_commands": [ "apt-get update && apt-get -y install git" ], "execute_commands": [ "terraform init -input=false", "terraform plan -input=false", "#terraform apply -auto-approve -input=false" ], "shell": "SH", "integration": { "identifier": "terraform-registry" }, "version": "latest" } }, "Snyk (SNYK_CLI)": { "description": "Snyk (SNYK_CLI)", "value": { "name": "Run Snyk CLI commands", "type": "SNYK_CLI", "trigger_time": "ON_EVERY_EXECUTION", "setup_commands": [ "apt-get update && apt-get -y install git" ], "execute_commands": [ "snyk test" ], "shell": "SH", "integration": { "identifier": "snyk" }, "version": "node-16" } }, "StackHawk CLI (STACK_HAWK_CLI)": { "description": "StackHawk CLI (STACK_HAWK_CLI)", "value": { "name": "Run StackHawk CLI commands", "type": "STACK_HAWK_CLI", "trigger_time": "ON_EVERY_EXECUTION", "setup_commands": [ "apt-get update && apt-get -y install git" ], "execute_commands": [ "hawk validate config stackhawk.yml", "hawk scan --repo-dir=." ], "shell": "SH", "integration": { "identifier": "stackhawk" } } }, "JMeter CLI (JMETER_CLI)": { "description": "JMeter CLI (JMETER_CLI)", "value": { "name": "Run JMeter CLI commands", "type": "JMETER_CLI", "trigger_time": "ON_EVERY_EXECUTION", "setup_commands": [ "apt-get update && apt-get -y install git" ], "execute_commands": [ "jmeter -n –t test.jmx -l testresults.jtl" ], "shell": "SH" } }, "Trivy CLI (TRIVY_CLI)": { "description": "Trivy CLI (TRIVY_CLI)", "value": { "name": "Run Trivy CLI commands", "type": "TRIVY_CLI", "trigger_time": "ON_EVERY_EXECUTION", "version": "0.69.3", "execute_commands": [ "trivy fs --severity HIGH,CRITICAL ." ], "shell": "SH" } }, "Blackfire PHP (BLACKFIRE_PHP)": { "description": "Blackfire PHP (BLACKFIRE_PHP)", "value": { "name": "Run Blackfire PHP CLI", "type": "BLACKFIRE_PHP", "trigger_time": "ON_EVERY_EXECUTION", "version": "latest", "integration": { "identifier": "blackfire" }, "execute_commands": [ "composer install", "blackfire run bin/console" ], "setup_commands": [ "apt-get update && apt-get -y install git" ], "shell": "BASH" } }, "Blackfire Python Profiling (BLACKFIRE_PYTHON)": { "description": "Blackfire Python Profiling (BLACKFIRE_PYTHON)", "value": { "name": "Profile Python Application", "type": "BLACKFIRE_PYTHON", "trigger_time": "ON_EVERY_EXECUTION", "version": "1.8.2", "shell": "BASH", "setup_commands": [ "pip install blackfire" ], "execute_commands": [ "blackfire run python manage.py test", "blackfire curl https://staging.example.com/api/products" ], "execute_every_command": true, "variables": [ { "key": "BLACKFIRE_SERVER_ID", "value": "$BLACKFIRE_SERVER_ID", "encrypted": true }, { "key": "BLACKFIRE_SERVER_TOKEN", "value": "$BLACKFIRE_SERVER_TOKEN", "encrypted": true } ] } }, "Blackfire GO (BLACKFIRE_GO)": { "description": "Blackfire GO (BLACKFIRE_GO)", "value": { "name": "Run Blackfire Go CLI", "type": "BLACKFIRE_GO", "trigger_time": "ON_EVERY_EXECUTION", "version": "latest", "integration": { "identifier": "blackfire" }, "execute_commands": [ "blackfire run ./go_bin" ], "setup_commands": [ "apt-get update && apt-get -y install git" ], "shell": "BASH" } }, "Docker (DOCKER)": { "description": "Docker (DOCKER)", "value": { "name": "Run docker commands", "type": "DOCKER", "trigger_time": "ON_EVERY_EXECUTION", "execute_commands": [ "docker --version" ], "setup_commands": [ "apt-get update -y", "apt-get install -y wget" ], "shell": "SH", "region": "us-east-1", "integration": { "identifier": "docker-registry" } } }, "Configure Pipeline Settings (PIPELINE_SETTINGS)": { "description": "Configure Pipeline Settings (PIPELINE_SETTINGS)", "value": { "name": "Update Pipeline Schedule", "type": "PIPELINE_SETTINGS", "trigger_time": "ON_EVERY_EXECUTION", "cron": "0 2 * * 1-5", "target_pipeline": { "id": 123, "identifier": "nightly-build", "project": { "name": "my-project" } } } }, "New Relic CLI (NEW_RELIC_CLI)": { "description": "New Relic CLI (NEW_RELIC_CLI)", "value": { "name": "Run New Relic CLI", "type": "NEW_RELIC_CLI", "trigger_time": "ON_EVERY_EXECUTION", "setup_commands": [ "apt-get update && apt-get -y install git" ], "execute_commands": [ "newrelic entity deployment create" ], "shell": "SH", "integration": { "identifier": "newrelic" } } }, "Contentful CLI (CONTENTFUL_CLI)": { "description": "Contentful CLI (CONTENTFUL_CLI)", "value": { "name": "Run Contentful CLI", "type": "CONTENTFUL_CLI", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "contentful", "type": "CONTENTFUL", "scope": "WORKSPACE" }, "environment": "master", "execute_commands": [ "contentful space list" ], "space": "Blank" } }, "Npm (NPM_PUBLISH)": { "description": "Npm (NPM_PUBLISH)", "value": { "name": "Run NPM publish", "type": "NPM_PUBLISH", "trigger_time": "ON_EVERY_EXECUTION", "integration": { "identifier": "github" }, "npm_registry": "GIT_HUB", "source_path": "/", "ignore_scripts": "true", "access": "PUBLIC", "tag": "latest" } }, "WP CLI (WP_CLI)": { "description": "WP CLI (WP_CLI)", "value": { "name": "Run WordPress CLI", "type": "WP_CLI", "trigger_time": "ON_EVERY_EXECUTION", "setup_commands": [ "apt-get update && apt-get -y install git" ], "execute_commands": [ "wp admin" ], "shell": "SH", "version": "cli", "config": "@staging:\n ssh: wpcli@staging.wp-cli.org" } }, "Tag Docker Image (PROMOTE_IMAGE)": { "description": "Tag Docker Image (PROMOTE_IMAGE)", "value": { "name": "Promote to production tag", "type": "PROMOTE_IMAGE", "trigger_time": "ON_EVERY_EXECUTION", "same_location": true, "src": { "docker_registry": "DOCKER_HUB", "image": "mycompany/myapp:latest", "integration": "docker_hub_integration" }, "dest": { "docker_registry": "GOOGLE_ARTIFACT_REGISTRY", "registry": "us-central1-docker.pkg.dev", "image": "my-gcp-project/my-repo/myapp:production", "integration": "google_service_account" } } }, "Git Merge (GIT_MERGE)": { "description": "Git Merge (GIT_MERGE)", "value": { "name": "Merge develop into main", "type": "GIT_MERGE", "trigger_time": "ON_EVERY_EXECUTION", "branch": "develop", "conflict_strategy": "FAIL", "dry_run": false, "no_fast_forward": true } }, "Claude Code (CLAUDE_CODE)": { "description": "Claude Code (CLAUDE_CODE)", "value": { "name": "Claude Code", "type": "CLAUDE_CODE", "trigger_time": "ON_EVERY_EXECUTION", "prompts": [ { "type": "INLINE", "value": "Review the code changes and suggest improvements" } ], "model": "sonnet", "settings": { "type": "INLINE", "value": "{\"max_turns\": 10}" }, "claude_args": "--max-turns 5", "integration": { "hash_id": "my_anthropic_integration" }, "dangerously_skip_permissions": true } } } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionResponse" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/pipelines/791/actions/1233", "html_url": "https://app.buddy.works/my-workspace/my-project/pipelines/pipeline/791/action/1233/edit", "id": 1233, "name": "mvn artifact", "type": "BUILD", "current_revision": "58e239079a2161fec0ba96ed166557157ad3dd79", "trigger_time": "ON_EVERY_EXECUTION", "run_next": "WAIT_ON_SUCCESS", "disabled": false, "ignore_errors": false, "pipeline": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/pipelines/791", "html_url": "https://app.buddy.works/my-workspace/my-project/pipelines/pipeline/791", "id": 791, "identifier": "build", "name": "build", "definition_source": "LOCAL", "git_config_ref": "NONE", "refs": [ "refs/heads/master" ], "events": [ { "type": "WEBHOOK" } ], "priority": "NORMAL", "disabled": false, "last_execution_status": "SUCCESSFUL", "last_execution_revision": "58e239079a2161fec0ba96ed166557157ad3dd79", "always_from_scratch": false, "ignore_fail_on_project_status": false, "strict_context": false, "no_skip_to_most_recent": false, "terminate_stale_runs": false, "auto_clear_cache": false, "fetch_all_refs": false, "fail_on_prepare_env_warning": true, "concurrent_pipeline_runs": false, "do_not_create_commit_status": false, "stale": false, "waiting_for_push": false, "resources": "DEFAULT", "git_changeset_base": "LATEST_RUN", "filesystem_changeset_base": "DATE_MODIFIED", "cpu": "X64", "description_required": false }, "loop": [], "docker_image_name": "library/maven", "docker_image_tag": "3.9.9", "execute_commands": [ "mvn artifact" ], "mount_filesystem_disable": false, "volume_mappings": [ "/:/buddy/my-project" ], "cached_dirs": [ "/root/.m2/repository" ], "shell": "BASH", "region": "", "image_location": "PUBLIC_REGISTRY", "docker_registry": "DOCKER_HUB", "execute_every_command": false, "ignore_image_pull_failures": false, "cache_base_image": true, "reset_entrypoint": false, "vt_suite": "" } } } } }, "security": [ { "oauth2": [ "EXECUTION_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/pipelines/{pipeline_id}/executions": { "get": { "tags": [ "Project API" ], "summary": "Returns list of executions for the specified pipeline", "operationId": "getExecutions", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "pipeline_id", "in": "path", "description": "The ID of the pipeline", "required": true, "schema": { "type": "integer", "format": "int32", "example": 123 } }, { "name": "page", "in": "query", "description": "The number of the successive pages (results are split into pages of per_page elements each).", "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "per_page", "in": "query", "description": "Specifies the number of returned elements on the page. The default value is 20.", "schema": { "type": "integer", "format": "int32", "example": 20 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutionsView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/pipelines/2/executions", "html_url": "https://app.buddy.works/my-workspace/my-project/pipelines/pipeline/2/executions", "page": 1, "page_size": 20, "total_page_count": 1, "element_count": 2, "total_element_count": 2, "executions": [ { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/pipelines/2/executions/2", "html_url": "https://app.buddy.works/my-workspace/my-project/pipelines/pipeline/2/execution/68e60c55592ab1f894ecace6", "id": 2, "start_date": "2025-10-08T07:01:42.029Z", "finish_date": "2025-10-08T07:01:45.886Z", "triggered_on": "EVENT", "priority": "NORMAL", "refresh": true, "clear_cache": true, "status": "SUCCESSFUL", "comment": "test", "branch": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/branches/dev-issue1", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/branch/dev-issue1", "name": "dev-issue1", "default": false }, "to_revision": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/commits/90d11b5b54108fa57b30ae286322b99b26d46ccb", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/commit/90d11b5b54108fa57b30ae286322b99b26d46ccb", "revision": "90d11b5b54108fa57b30ae286322b99b26d46ccb", "author_date": "2025-10-08T06:22:11Z", "commit_date": "2025-10-08T06:22:11Z", "message": "Added sad", "committer": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "Mike", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1759904496204", "email": "mike@company.com", "admin": true, "workspace_owner": true }, "author": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "Mike", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1759904496204", "email": "mike@company.com", "admin": true, "workspace_owner": true } }, "creator": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "Mike", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1759904496204", "email": "mike@company.com", "admin": true, "workspace_owner": true }, "environment": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/environments/nZrnl40Y", "html_url": "https://app.buddy.works/my-workspace/my-project/environments/environment/nZrnl40Y", "name": "staging", "identifier": "my-staging", "id": "nZrnl40Y", "scope": "PROJECT" }, "artifact": { "url": "https://api.buddy.works/workspaces/my-workspace/artifacts/x5169jL2", "html_url": "https://app.buddy.works/my-workspace/-/artifacts/x5169jL2/versions", "id": "x5169jL2", "type": "CONTAINER", "name": "My Application Artifact", "identifier": "my-app-artifact", "scope": "WORKSPACE", "size": 1048576000 }, "artifact_version": { "url": "https://api.buddy.works/workspaces/my-workspace/artifacts/x5169jL2/versions/0YgEzRGv", "html_url": "https://app.buddy.works/my-workspace/-/artifacts/x5169jL2/versions/0YgEzRGv", "version_url": "https://latest-my-artifact.bucket-1.registry.sh/", "id": "0YgEzRGv", "version": "latest", "size": 1048576, "created_date": "2024-01-20T10:30:00Z" } }, { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/pipelines/2/executions/1", "html_url": "https://app.buddy.works/my-workspace/my-project/pipelines/pipeline/2/execution/68e60c20592ab1f894ecacd4", "id": 1, "start_date": "2025-10-08T07:00:48.912Z", "finish_date": "2025-10-08T07:00:54.148Z", "triggered_on": "CLICK", "priority": "NORMAL", "refresh": true, "clear_cache": true, "status": "SUCCESSFUL", "comment": "test", "branch": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/branches/master", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/branch/master", "name": "master", "default": true }, "to_revision": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/commits/90d11b5b54108fa57b30ae286322b99b26d46ccb", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/commit/90d11b5b54108fa57b30ae286322b99b26d46ccb", "revision": "90d11b5b54108fa57b30ae286322b99b26d46ccb", "author_date": "2025-10-08T06:22:11Z", "commit_date": "2025-10-08T06:22:11Z", "message": "Added sad", "committer": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "Mike", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1759904496204", "email": "mike@company.com", "admin": true, "workspace_owner": true }, "author": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "Mike", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1759904496204", "email": "mike@company.com", "admin": true, "workspace_owner": true } }, "creator": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "Mike", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1759904496204", "email": "mike@company.com", "admin": true, "workspace_owner": true } } ] } } } } }, "security": [ { "oauth2": [ "EXECUTION_INFO" ] } ] }, "post": { "tags": [ "Project API" ], "summary": "Triggers a new execution of the pipeline", "operationId": "runPipeline", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "pipeline_id", "in": "path", "description": "The ID of the pipeline", "required": true, "schema": { "type": "integer", "format": "int32", "example": 123 } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunExecutionRequest" }, "examples": { "Run pipeline with specific revision": { "description": "Run pipeline with specific revision", "value": { "to_revision": { "revision": "a3006ad167" }, "comment": "Deploy hotfix to production" } }, "Run pipeline with priority and cache clearing": { "description": "Run pipeline with priority and cache clearing", "value": { "to_revision": { "revision": "009cfc7ece" }, "from_revision": { "revision": "1e20920873" }, "comment": "Testing new features", "refresh": false, "clear_cache": true, "priority": "HIGH" } }, "Run pipeline with custom variables and selected actions": { "description": "Run pipeline with custom variables and selected actions", "value": { "to_revision": { "revision": "HEAD" }, "comment": "hotfix", "clear_cache": true, "priority": "HIGH", "variables": [ { "key": "version", "value": "1.0" }, { "key": "pass", "value": "qwerty", "encrypted": true } ], "actions_to_run": [ 1, 2 ] } }, "Run pipeline with artifact version and environment": { "description": "Run pipeline with artifact version and environment", "value": { "to_revision": { "revision": "HEAD" }, "comment": "Deploy specific artifact to staging", "environment": "staging", "artifact_version": "my_app:1.2.3" } } } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutionView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/pipelines/2/executions/2", "html_url": "https://app.buddy.works/my-workspace/my-project/pipelines/pipeline/2/execution/68e60c55592ab1f894ecace6", "id": 2, "start_date": "2025-10-08T07:01:42.029Z", "finish_date": "2025-10-08T07:01:45.886Z", "triggered_on": "EVENT", "priority": "NORMAL", "refresh": true, "clear_cache": true, "status": "SUCCESSFUL", "comment": "test", "branch": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/branches/dev-issue1", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/branch/dev-issue1", "name": "dev-issue1", "default": false }, "to_revision": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/commits/90d11b5b54108fa57b30ae286322b99b26d46ccb", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/commit/90d11b5b54108fa57b30ae286322b99b26d46ccb", "revision": "90d11b5b54108fa57b30ae286322b99b26d46ccb", "author_date": "2025-10-08T06:22:11Z", "commit_date": "2025-10-08T06:22:11Z", "message": "Added sad", "committer": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "Mike", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1759904496204", "email": "mike@company.com", "admin": true, "workspace_owner": true }, "author": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "Mike", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1759904496204", "email": "mike@company.com", "admin": true, "workspace_owner": true } }, "creator": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "Mike", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1759904496204", "email": "mike@company.com", "admin": true, "workspace_owner": true }, "environment": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/environments/nZrnl40Y", "html_url": "https://app.buddy.works/my-workspace/my-project/environments/environment/nZrnl40Y", "name": "staging", "identifier": "my-staging", "id": "nZrnl40Y", "scope": "PROJECT" }, "artifact": { "url": "https://api.buddy.works/workspaces/my-workspace/artifacts/x5169jL2", "html_url": "https://app.buddy.works/my-workspace/-/artifacts/x5169jL2/versions", "id": "x5169jL2", "type": "CONTAINER", "name": "My Application Artifact", "identifier": "my-app-artifact", "scope": "WORKSPACE", "size": 1048576000 }, "artifact_version": { "url": "https://api.buddy.works/workspaces/my-workspace/artifacts/x5169jL2/versions/0YgEzRGv", "html_url": "https://app.buddy.works/my-workspace/-/artifacts/x5169jL2/versions/0YgEzRGv", "version_url": "https://latest-my-artifact.bucket-1.registry.sh/", "id": "0YgEzRGv", "version": "latest", "size": 1048576, "created_date": "2024-01-20T10:30:00Z" }, "pipeline": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/pipelines/2", "html_url": "https://app.buddy.works/my-workspace/my-project/pipelines/pipeline/2", "id": 2, "identifier": "test", "name": "Tests", "definition_source": "LOCAL", "git_config_ref": "NONE", "refs": [ "refs/heads/master" ], "events": [ { "type": "PUSH", "refs": [ ":context", "refs/heads/dev-*" ] } ], "priority": "NORMAL", "last_execution_status": "SUCCESSFUL", "last_execution_revision": "90d11b5b54108fa57b30ae286322b99b26d46ccb", "execution_message_template": "test", "always_from_scratch": true, "ignore_fail_on_project_status": true, "strict_context": false, "no_skip_to_most_recent": true, "terminate_stale_runs": false, "auto_clear_cache": true, "fail_on_prepare_env_warning": true, "concurrent_pipeline_runs": true, "do_not_create_commit_status": true, "waiting_for_push": false, "resources": "DEFAULT", "git_changeset_base": "LATEST_RUN_MATCHING_REF", "filesystem_changeset_base": "CONTENTS", "cpu": "X64", "description_required": false }, "action_executions": [ { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/pipelines/2/executions/2/action_executions/68e60c55592ab1f894ecace8", "html_url": "https://app.buddy.works/my-workspace/my-project/pipelines/pipeline/2/execution/68e60c55592ab1f894ecace6/?actionExecutionId=68e60c55592ab1f894ecace8", "action_execution_id": "68e60c55592ab1f894ecace8", "start_date": "2025-10-08T07:01:42.67Z", "finish_date": "2025-10-08T07:01:45.861Z", "status": "SUCCESSFUL", "progress": 100, "action": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/pipelines/2/actions/1", "html_url": "https://app.buddy.works/my-workspace/my-project/pipelines/pipeline/2/action/1/edit", "id": 1, "name": "ls -la", "type": "BUILD", "current_revision": "90d11b5b54108fa57b30ae286322b99b26d46ccb", "trigger_time": "ON_EVERY_EXECUTION", "run_next": "WAIT_ON_SUCCESS", "disabled": false, "timeout": null, "ignore_errors": false, "last_execution_status": "SUCCESSFUL" }, "passed_variables": [], "outputted_variables": [] } ] } } } } }, "security": [ { "oauth2": [ "EXECUTION_RUN" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/pipelines/{pipeline_id}/executions/{id}": { "get": { "tags": [ "Project API" ], "summary": "Returns details of a single execution", "operationId": "getExecution", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "pipeline_id", "in": "path", "description": "The ID of the pipeline", "required": true, "schema": { "type": "integer", "format": "int32", "example": 123 } }, { "name": "id", "in": "path", "description": "The ID of the execution", "required": true, "schema": { "type": "integer", "format": "int32", "example": 123456 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutionView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/pipelines/2/executions/2", "html_url": "https://app.buddy.works/my-workspace/my-project/pipelines/pipeline/2/execution/68e60c55592ab1f894ecace6", "id": 2, "start_date": "2025-10-08T07:01:42.029Z", "finish_date": "2025-10-08T07:01:45.886Z", "triggered_on": "EVENT", "priority": "NORMAL", "refresh": true, "clear_cache": true, "status": "SUCCESSFUL", "comment": "test", "branch": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/branches/dev-issue1", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/branch/dev-issue1", "name": "dev-issue1", "default": false }, "to_revision": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/commits/90d11b5b54108fa57b30ae286322b99b26d46ccb", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/commit/90d11b5b54108fa57b30ae286322b99b26d46ccb", "revision": "90d11b5b54108fa57b30ae286322b99b26d46ccb", "author_date": "2025-10-08T06:22:11Z", "commit_date": "2025-10-08T06:22:11Z", "message": "Added sad", "committer": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "Mike", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1759904496204", "email": "mike@company.com", "admin": true, "workspace_owner": true }, "author": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "Mike", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1759904496204", "email": "mike@company.com", "admin": true, "workspace_owner": true } }, "creator": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "Mike", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1759904496204", "email": "mike@company.com", "admin": true, "workspace_owner": true }, "environment": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/environments/nZrnl40Y", "html_url": "https://app.buddy.works/my-workspace/my-project/environments/environment/nZrnl40Y", "name": "staging", "identifier": "my-staging", "id": "nZrnl40Y", "scope": "PROJECT" }, "artifact": { "url": "https://api.buddy.works/workspaces/my-workspace/artifacts/x5169jL2", "html_url": "https://app.buddy.works/my-workspace/-/artifacts/x5169jL2/versions", "id": "x5169jL2", "type": "CONTAINER", "name": "My Application Artifact", "identifier": "my-app-artifact", "scope": "WORKSPACE", "size": 1048576000 }, "artifact_version": { "url": "https://api.buddy.works/workspaces/my-workspace/artifacts/x5169jL2/versions/0YgEzRGv", "html_url": "https://app.buddy.works/my-workspace/-/artifacts/x5169jL2/versions/0YgEzRGv", "version_url": "https://latest-my-artifact.bucket-1.registry.sh/", "id": "0YgEzRGv", "version": "latest", "size": 1048576, "created_date": "2024-01-20T10:30:00Z" }, "pipeline": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/pipelines/2", "html_url": "https://app.buddy.works/my-workspace/my-project/pipelines/pipeline/2", "id": 2, "identifier": "test", "name": "Tests", "definition_source": "LOCAL", "git_config_ref": "NONE", "refs": [ "refs/heads/master" ], "events": [ { "type": "PUSH", "refs": [ ":context", "refs/heads/dev-*" ] } ], "priority": "NORMAL", "last_execution_status": "SUCCESSFUL", "last_execution_revision": "90d11b5b54108fa57b30ae286322b99b26d46ccb", "execution_message_template": "test", "always_from_scratch": true, "ignore_fail_on_project_status": true, "strict_context": false, "no_skip_to_most_recent": true, "terminate_stale_runs": false, "auto_clear_cache": true, "fail_on_prepare_env_warning": true, "concurrent_pipeline_runs": true, "do_not_create_commit_status": true, "waiting_for_push": false, "resources": "DEFAULT", "git_changeset_base": "LATEST_RUN_MATCHING_REF", "filesystem_changeset_base": "CONTENTS", "cpu": "X64", "description_required": false }, "action_executions": [ { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/pipelines/2/executions/2/action_executions/68e60c55592ab1f894ecace8", "html_url": "https://app.buddy.works/my-workspace/my-project/pipelines/pipeline/2/execution/68e60c55592ab1f894ecace6/?actionExecutionId=68e60c55592ab1f894ecace8", "action_execution_id": "68e60c55592ab1f894ecace8", "start_date": "2025-10-08T07:01:42.67Z", "finish_date": "2025-10-08T07:01:45.861Z", "status": "SUCCESSFUL", "progress": 100, "action": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/pipelines/2/actions/1", "html_url": "https://app.buddy.works/my-workspace/my-project/pipelines/pipeline/2/action/1/edit", "id": 1, "name": "ls -la", "type": "BUILD", "current_revision": "90d11b5b54108fa57b30ae286322b99b26d46ccb", "trigger_time": "ON_EVERY_EXECUTION", "run_next": "WAIT_ON_SUCCESS", "disabled": false, "timeout": null, "ignore_errors": false, "last_execution_status": "SUCCESSFUL" }, "passed_variables": [], "outputted_variables": [] } ] } } } } }, "security": [ { "oauth2": [ "EXECUTION_INFO" ] } ] }, "patch": { "tags": [ "Project API" ], "summary": "Cancel, retry, or perform other operations on an execution", "operationId": "cancelOrRetryPipeline", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "pipeline_id", "in": "path", "description": "The ID of the pipeline", "required": true, "schema": { "type": "integer", "format": "int32", "example": 123 } }, { "name": "id", "in": "path", "description": "The ID of the execution", "required": true, "schema": { "type": "integer", "format": "int32", "example": 123456 } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelRetryExecutionRequest" }, "examples": { "Cancel execution": { "description": "Cancel execution", "value": { "operation": "CANCEL" } }, "Retry execution": { "description": "Retry execution", "value": { "operation": "RETRY" } }, "Approve execution": { "description": "Approve execution", "value": { "operation": "APPLY", "approve_action_id": 456 } }, "Apply variables to execution": { "description": "Apply variables to execution", "value": { "operation": "APPLY_VARIABLES", "approve_action_id": 789, "variables": [ { "key": "version", "value": "2.0" }, { "key": "environment", "value": "production" } ] } } } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutionView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/pipelines/2/executions/2", "html_url": "https://app.buddy.works/my-workspace/my-project/pipelines/pipeline/2/execution/68e60c55592ab1f894ecace6", "id": 2, "start_date": "2025-10-08T07:01:42.029Z", "finish_date": "2025-10-08T07:01:45.886Z", "triggered_on": "EVENT", "priority": "NORMAL", "refresh": true, "clear_cache": true, "status": "SUCCESSFUL", "comment": "test", "branch": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/branches/dev-issue1", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/branch/dev-issue1", "name": "dev-issue1", "default": false }, "to_revision": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/commits/90d11b5b54108fa57b30ae286322b99b26d46ccb", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/commit/90d11b5b54108fa57b30ae286322b99b26d46ccb", "revision": "90d11b5b54108fa57b30ae286322b99b26d46ccb", "author_date": "2025-10-08T06:22:11Z", "commit_date": "2025-10-08T06:22:11Z", "message": "Added sad", "committer": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "Mike", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1759904496204", "email": "mike@company.com", "admin": true, "workspace_owner": true }, "author": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "Mike", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1759904496204", "email": "mike@company.com", "admin": true, "workspace_owner": true } }, "creator": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "Mike", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1759904496204", "email": "mike@company.com", "admin": true, "workspace_owner": true }, "environment": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/environments/nZrnl40Y", "html_url": "https://app.buddy.works/my-workspace/my-project/environments/environment/nZrnl40Y", "name": "staging", "identifier": "my-staging", "id": "nZrnl40Y", "scope": "PROJECT" }, "artifact": { "url": "https://api.buddy.works/workspaces/my-workspace/artifacts/x5169jL2", "html_url": "https://app.buddy.works/my-workspace/-/artifacts/x5169jL2/versions", "id": "x5169jL2", "type": "CONTAINER", "name": "My Application Artifact", "identifier": "my-app-artifact", "scope": "WORKSPACE", "size": 1048576000 }, "artifact_version": { "url": "https://api.buddy.works/workspaces/my-workspace/artifacts/x5169jL2/versions/0YgEzRGv", "html_url": "https://app.buddy.works/my-workspace/-/artifacts/x5169jL2/versions/0YgEzRGv", "version_url": "https://latest-my-artifact.bucket-1.registry.sh/", "id": "0YgEzRGv", "version": "latest", "size": 1048576, "created_date": "2024-01-20T10:30:00Z" }, "pipeline": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/pipelines/2", "html_url": "https://app.buddy.works/my-workspace/my-project/pipelines/pipeline/2", "id": 2, "identifier": "test", "name": "Tests", "definition_source": "LOCAL", "git_config_ref": "NONE", "refs": [ "refs/heads/master" ], "events": [ { "type": "PUSH", "refs": [ ":context", "refs/heads/dev-*" ] } ], "priority": "NORMAL", "last_execution_status": "SUCCESSFUL", "last_execution_revision": "90d11b5b54108fa57b30ae286322b99b26d46ccb", "execution_message_template": "test", "always_from_scratch": true, "ignore_fail_on_project_status": true, "strict_context": false, "no_skip_to_most_recent": true, "terminate_stale_runs": false, "auto_clear_cache": true, "fail_on_prepare_env_warning": true, "concurrent_pipeline_runs": true, "do_not_create_commit_status": true, "waiting_for_push": false, "resources": "DEFAULT", "git_changeset_base": "LATEST_RUN_MATCHING_REF", "filesystem_changeset_base": "CONTENTS", "cpu": "X64", "description_required": false }, "action_executions": [ { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/pipelines/2/executions/2/action_executions/68e60c55592ab1f894ecace8", "html_url": "https://app.buddy.works/my-workspace/my-project/pipelines/pipeline/2/execution/68e60c55592ab1f894ecace6/?actionExecutionId=68e60c55592ab1f894ecace8", "action_execution_id": "68e60c55592ab1f894ecace8", "start_date": "2025-10-08T07:01:42.67Z", "finish_date": "2025-10-08T07:01:45.861Z", "status": "SUCCESSFUL", "progress": 100, "action": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/pipelines/2/actions/1", "html_url": "https://app.buddy.works/my-workspace/my-project/pipelines/pipeline/2/action/1/edit", "id": 1, "name": "ls -la", "type": "BUILD", "current_revision": "90d11b5b54108fa57b30ae286322b99b26d46ccb", "trigger_time": "ON_EVERY_EXECUTION", "run_next": "WAIT_ON_SUCCESS", "disabled": false, "timeout": null, "ignore_errors": false, "last_execution_status": "SUCCESSFUL" }, "passed_variables": [], "outputted_variables": [] } ] } } } } }, "security": [ { "oauth2": [ "EXECUTION_RUN" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/pipelines/{pipeline_id}/executions/{execution_id}/action_executions/{id}": { "get": { "tags": [ "Project API" ], "summary": "Returns details of a single action execution", "operationId": "getActionExecution", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "pipeline_id", "in": "path", "description": "The ID of the pipeline", "required": true, "schema": { "type": "integer", "format": "int32", "example": 123 } }, { "name": "execution_id", "in": "path", "description": "The ID of the execution", "required": true, "schema": { "type": "integer", "format": "int32", "example": 123456 } }, { "name": "id", "in": "path", "description": "The ID of the action execution", "required": true, "schema": { "type": "string", "example": "68e49e0e0875a8847e0980da" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionExecutionView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/pipelines/89/executions/123456/action_executions/68e77c82b38c40fc0535ee55", "html_url": "https://app.buddy.works/my-workspace/my-project/pipelines/pipeline/89/execution/68e77c82b38c40fc0535ee51/?actionExecutionId=68e77c82b38c40fc0535ee55", "start_date": "2025-10-09T09:12:38.688Z", "finish_date": "2025-10-09T09:12:42.322Z", "status": "SUCCESSFUL", "progress": 100, "action": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/pipelines/89/actions/149", "html_url": "https://app.buddy.works/my-workspace/my-project/pipelines/pipeline/89/action/149/edit", "id": 149, "name": "Transfer to AWS S3/my-bucket", "type": "AMAZON_S3", "current_revision": "2aeec94b11d79263c0076e8281e93ceacf88211c", "trigger_time": "ON_EVERY_EXECUTION", "run_next": "WAIT_ON_SUCCESS", "disabled": false, "timeout": null, "ignore_errors": false, "integration": { "identifier": "amazon-web-services" }, "last_execution_status": "SUCCESSFUL" }, "passed_variables": [], "outputted_variables": [], "log": [ "Integration: amazon-web-services|3A97MwY02W1GEVkmzePKxRyDnE", "Listing files for deployment...", "File list ready. Starting upload...", "Deploying...", "Creating directory dir...", "Uploading file dir/readme.txt...", "Uploading file sad...", "Deployment finished successfully" ] } } } } }, "security": [ { "oauth2": [ "EXECUTION_INFO" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/pipelines/{pipeline_id}/executions/{execution_id}/action_executions/{id}/logs": { "get": { "tags": [ "Project API" ], "summary": "Returns paginated console output logs of a single action execution", "operationId": "getActionExecutionLogs", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "pipeline_id", "in": "path", "description": "The ID of the pipeline", "required": true, "schema": { "type": "integer", "format": "int32", "example": 123 } }, { "name": "execution_id", "in": "path", "description": "The ID of the execution", "required": true, "schema": { "type": "integer", "format": "int32", "example": 123456 } }, { "name": "id", "in": "path", "description": "The ID of the action execution", "required": true, "schema": { "type": "string", "example": "68e49e0e0875a8847e0980da" } }, { "name": "offset", "in": "query", "description": "The starting line number (0-based). Defaults to 0", "schema": { "type": "integer", "format": "int32", "example": 0 } }, { "name": "limit", "in": "query", "description": "The maximum number of log lines to return. Defaults to 100, max 1000", "schema": { "type": "integer", "format": "int32", "example": 100 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionExecutionLogsView" } } } } }, "security": [ { "oauth2": [ "EXECUTION_INFO" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/pipelines/{pipeline_id}/yaml": { "get": { "tags": [ "Project API" ], "summary": "Returns pipeline configuration in YAML format", "operationId": "getPipelineByYaml", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "pipeline_id", "in": "path", "description": "The ID of the pipeline", "required": true, "schema": { "type": "integer", "format": "int32", "example": 123 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineYamlView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/pipelines/123", "html_url": "https://app.buddy.works/my-workspace/my-project/pipelines/pipeline/123", "yaml": "LSBwaXBlbGluZTogdmFyeQogIHJlZnM6CiAgLSByZWZzL2hlYWRzL21hc3RlcgogIGV2ZW50czoKICAtIHR5cGU6IFdFQkhPT0sKICBmYWlsX29uX3ByZXBhcmVfZW52X3dhcm5pbmc6IHRydWUKICBhY3Rpb25zOgogIC0gYWN0aW9uOiBQYXNzIGFyZ3VtZW50cwogICAgdHlwZTogV0FJVF9GT1JfVkFSSUFCTEVTCiAgICB2YXJpYWJsZXM6CiAgICAtIGtleTogYWxhCiAgICAgIGVuY3J5cHRlZDogdHJ1ZQogIC0gYWN0aW9uOiAiZWNobyBcImFsYTogJGFsYVwiIgogICAgdHlwZTogQlVJTEQKICAgIGRvY2tlcl9pbWFnZV9uYW1lOiBidWRkeS9sb2NhbHNoZWxsCiAgICBkb2NrZXJfaW1hZ2VfdGFnOiB1YnVudHVfMjQuMDQKICAgIGV4ZWN1dGVfY29tbWFuZHM6CiAgICAtICJlY2hvIFwiYWxhOiAkYWxhXCIiCiAgICBzaGVsbDogQkFTSAo=" } } } } }, "security": [ { "oauth2": [ "EXECUTION_INFO" ] } ] }, "patch": { "tags": [ "Project API" ], "summary": "Update pipeline configuration using YAML definition", "operationId": "updatePipelineByYaml", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "pipeline_id", "in": "path", "description": "The ID of the pipeline", "required": true, "schema": { "type": "integer", "format": "int32", "example": 123 } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineYamlView" }, "example": { "yaml": "LSBwaXBlbGluZTogdmFyeQogIHJlZnM6CiAgLSByZWZzL2hlYWRzL21hc3RlcgogIGV2ZW50czoKICAtIHR5cGU6IFdFQkhPT0sKICBmYWlsX29uX3ByZXBhcmVfZW52X3dhcm5pbmc6IHRydWUKICBhY3Rpb25zOgogIC0gYWN0aW9uOiBQYXNzIGFyZ3VtZW50cwogICAgdHlwZTogV0FJVF9GT1JfVkFSSUFCTEVTCiAgICB2YXJpYWJsZXM6CiAgICAtIGtleTogYWxhCiAgICAgIGVuY3J5cHRlZDogdHJ1ZQogIC0gYWN0aW9uOiAiZWNobyBcImFsYTogJGFsYVwiIgogICAgdHlwZTogQlVJTEQKICAgIGRvY2tlcl9pbWFnZV9uYW1lOiBidWRkeS9sb2NhbHNoZWxsCiAgICBkb2NrZXJfaW1hZ2VfdGFnOiB1YnVudHVfMjQuMDQKICAgIGV4ZWN1dGVfY29tbWFuZHM6CiAgICAtICJlY2hvIFwiYWxhOiAkYWxhXCIiCiAgICBzaGVsbDogQkFTSAo=" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineResponse" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/pipelines/123", "html_url": "https://app.buddy.works/my-workspace/my-project/pipelines/pipeline/123", "id": 123, "identifier": "deploy-production", "name": "Deploy to production", "definition_source": "LOCAL", "git_config_ref": "NONE", "refs": [ "refs/heads/main" ], "events": [ { "type": "PUSH" } ], "priority": "NORMAL", "disabled": false, "last_execution_status": "SUCCESSFUL", "create_date": "2023-01-15T10:30:00Z", "always_from_scratch": false, "ignore_fail_on_project_status": false, "strict_context": false, "no_skip_to_most_recent": false, "terminate_stale_runs": false, "auto_clear_cache": false, "fetch_all_refs": false, "fetch_lfs": false, "fail_on_prepare_env_warning": true, "concurrent_pipeline_runs": false, "do_not_create_commit_status": false, "stale": false, "waiting_for_push": false, "resources": "DEFAULT", "git_changeset_base": "LATEST_RUN", "filesystem_changeset_base": "DATE_MODIFIED", "cpu": "X64", "description_required": false, "project": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project", "html_url": "https://app.buddy.works/my-workspace/projects/my-project", "name": "my-project", "display_name": "My Project", "status": "ACTIVE" }, "creator": { "url": "https://api.buddy.works/workspaces/my-workspace/members/123", "html_url": "https://app.buddy.works/my-workspace/-/profile/123", "id": 123, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/123/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6/w/32/32/AVATAR.png?ts=1674644200000", "email": "john.doe@company.com", "admin": true, "workspace_owner": false }, "cache_scope": "PIPELINE", "variables": [], "environments": [], "permissions": { "others": "DEFAULT" }, "manage_variables_by_yaml": false, "manage_permissions_by_yaml": false, "actions": [ { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/pipelines/123/actions/456", "html_url": "https://app.buddy.works/my-workspace/my-project/pipelines/pipeline/123/action/456/edit", "id": 456, "name": "Build application", "type": "BUILD", "trigger_time": "ON_EVERY_EXECUTION", "last_execution_status": "SUCCESSFUL", "current_revision": "abc123def456", "disabled": false, "ignore_errors": false, "run_next": "WAIT_ON_SUCCESS" } ] } } } } }, "security": [ { "oauth2": [ "EXECUTION_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/repository/branches": { "get": { "tags": [ "Project API" ], "summary": "Returns list of branches in the repository", "operationId": "getBranches", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BranchesView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/branches", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/branches", "branches": [ { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/branches/master", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/branch/master", "name": "master", "default": true }, { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/branches/dev", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/branch/dev", "name": "dev", "default": false }, { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/branches/stage", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/branch/stage", "name": "stage", "default": false } ] } } } } }, "security": [ { "oauth2": [ "REPOSITORY_READ" ] } ] }, "post": { "tags": [ "Project API" ], "summary": "Creates a new branch in the repository", "operationId": "addBranch", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBranchRequest" }, "example": { "name": "feature/new-authentication", "commit": { "revision": "abc123def456" }, "description": "Branch for implementing new authentication system" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BranchView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/branches/master", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/branch/master", "name": "master", "commit": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/commits/a089d82fe56335c8abd8790859bba925ad10f9d1", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/commit/a089d82fe56335c8abd8790859bba925ad10f9d1", "revision": "a089d82fe56335c8abd8790859bba925ad10f9d1", "author_date": "2025-10-10T04:23:04Z", "commit_date": "2025-10-10T04:23:04Z", "message": "Added vitest-output.xml", "committer": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1760014081477", "email": "john.doe@company.com", "admin": true, "workspace_owner": true }, "author": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1760014081477", "email": "john.doe@company.com", "admin": true, "workspace_owner": true } }, "description": "", "default": true } } } } }, "security": [ { "oauth2": [ "REPOSITORY_WRITE" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/repository/branches/{name}": { "get": { "tags": [ "Project API" ], "summary": "Returns details of a single branch", "operationId": "getBranch", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "name", "in": "path", "description": "The name of the branch", "required": true, "schema": { "type": "string", "example": "main" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BranchView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/branches/master", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/branch/master", "name": "master", "commit": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/commits/a089d82fe56335c8abd8790859bba925ad10f9d1", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/commit/a089d82fe56335c8abd8790859bba925ad10f9d1", "revision": "a089d82fe56335c8abd8790859bba925ad10f9d1", "author_date": "2025-10-10T04:23:04Z", "commit_date": "2025-10-10T04:23:04Z", "message": "Added vitest-output.xml", "committer": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1760014081477", "email": "john.doe@company.com", "admin": true, "workspace_owner": true }, "author": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1760014081477", "email": "john.doe@company.com", "admin": true, "workspace_owner": true } }, "description": "", "default": true } } } } }, "security": [ { "oauth2": [ "REPOSITORY_READ" ] } ] }, "delete": { "tags": [ "Project API" ], "summary": "Deletes a branch from the repository", "operationId": "deleteBranch", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "name", "in": "path", "description": "The name of the branch", "required": true, "schema": { "type": "string", "example": "main" } } ], "responses": { "204": { "description": "Branch deleted successfully" } }, "security": [ { "oauth2": [ "REPOSITORY_WRITE" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/repository/commits": { "get": { "tags": [ "Project API" ], "summary": "Returns list of commits from the repository", "operationId": "getCommits", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "page", "in": "query", "description": "The number of the successive pages (results are split into pages of per_page elements each).", "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "per_page", "in": "query", "description": "Specifies the number of returned elements on the page. The default value is 20.", "schema": { "type": "integer", "format": "int32", "example": 20 } }, { "name": "path", "in": "query", "description": "Filter commits by file path", "schema": { "type": "string", "example": "src/main.js" } }, { "name": "branch", "in": "query", "description": "Filter commits by branch name", "schema": { "type": "string", "example": "main" } }, { "name": "author", "in": "query", "description": "Filter commits by author name or email", "schema": { "type": "string", "example": "john.doe@example.com" } }, { "name": "since", "in": "query", "description": "Filter commits since date (ISO 8601 format)", "schema": { "type": "string", "example": "2025-01-01T00:00:00Z" } }, { "name": "until", "in": "query", "description": "Filter commits until date (ISO 8601 format)", "schema": { "type": "string", "example": "2025-12-31T23:59:59Z" } }, { "name": "revision", "in": "query", "description": "SHA or branch/tag to start listing commits from. Default: the repository’s default branch (usually master)", "schema": { "type": "string", "example": "c4afae9e62392c0b71f75fe571cbaa745b9b0aa5" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommitsView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/commits", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/commits", "commits": [ { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/commits/a089d82fe56335c8abd8790859bba925ad10f9d1", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/commit/a089d82fe56335c8abd8790859bba925ad10f9d1", "revision": "a089d82fe56335c8abd8790859bba925ad10f9d1", "author_date": "2025-10-10T04:23:04Z", "commit_date": "2025-10-10T04:23:04Z", "message": "Added vitest-output.xml", "committer": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1760014081477", "email": "john.doe@company.com", "admin": true, "workspace_owner": true }, "author": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1760014081477", "email": "john.doe@company.com", "admin": true, "workspace_owner": true } }, { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/commits/ced6de63ca555fad8d2290c1c158f87232ffd9e1", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/commit/ced6de63ca555fad8d2290c1c158f87232ffd9e1", "revision": "ced6de63ca555fad8d2290c1c158f87232ffd9e1", "author_date": "2025-10-09T12:51:53Z", "commit_date": "2025-10-09T12:51:53Z", "message": "Changes to .bubby.yml", "committer": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1760014081477", "email": "john.doe@company.com", "admin": true, "workspace_owner": true }, "author": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1760014081477", "email": "john.doe@company.com", "admin": true, "workspace_owner": true } } ] } } } } }, "security": [ { "oauth2": [ "REPOSITORY_READ" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/repository/commits/{revision}": { "get": { "tags": [ "Project API" ], "summary": "Returns details of a single commit", "operationId": "getCommit", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "revision", "in": "path", "description": "The git revision (commit SHA, branch name, or tag name)", "required": true, "schema": { "type": "string", "example": "abc123def456" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommitView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/commits/a089d82fe56335c8abd8790859bba925ad10f9d1", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/commit/a089d82fe56335c8abd8790859bba925ad10f9d1", "revision": "a089d82fe56335c8abd8790859bba925ad10f9d1", "author_date": "2025-10-10T04:23:04Z", "commit_date": "2025-10-10T04:23:04Z", "message": "Added vitest-output.xml", "committer": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1760014081477", "email": "john.doe@company.com", "admin": true, "workspace_owner": true }, "author": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1760014081477", "email": "john.doe@company.com", "admin": true, "workspace_owner": true }, "stats": { "additions": 255, "deletions": 0, "total": 255 }, "files": [ { "file_name": "/vitest-output.xml", "status": "ADDED", "additions": 255, "deletions": 0, "total": 255, "patch": "@@ -0,0 +1,255 @@\n+\n+\n+ \n+ \n..." } ], "content_url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/contents?revision=a089d82fe56335c8abd8790859bba925ad10f9d1", "parents": [ { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/commits/ced6de63ca555fad8d2290c1c158f87232ffd9e1", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/commit/ced6de63ca555fad8d2290c1c158f87232ffd9e1", "revision": "ced6de63ca555fad8d2290c1c158f87232ffd9e1" } ] } } } } }, "security": [ { "oauth2": [ "REPOSITORY_READ" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/repository/comparison/{base}...{head}": { "get": { "tags": [ "Project API" ], "summary": "Returns the changes between two points. The response from the API is equivalent to running the git log base...head command", "operationId": "getComparison", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "base", "in": "path", "description": "The revision before the first one from the returned list", "required": true, "schema": { "type": "string", "example": "7c4786ffc65816bc3cd2418c3ceeb34134f4b03a" } }, { "name": "head", "in": "path", "description": "The last revision in the returned list", "required": true, "schema": { "type": "string", "example": "d643744fbe5ebf2906a4d075a5b97110" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommitComparisonView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/comparison", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/commits", "commits": [ { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/commits/a089d82fe56335c8abd8790859bba925ad10f9d1", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/commit/a089d82fe56335c8abd8790859bba925ad10f9d1", "revision": "a089d82fe56335c8abd8790859bba925ad10f9d1", "author_date": "2025-10-10T04:23:04Z", "commit_date": "2025-10-10T04:23:04Z", "message": "Added vitest-output.xml", "committer": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1760014081477", "email": "john.doe@company.com", "admin": true, "workspace_owner": true }, "author": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1760014081477", "email": "john.doe@company.com", "admin": true, "workspace_owner": true } }, { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/commits/ced6de63ca555fad8d2290c1c158f87232ffd9e1", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/commit/ced6de63ca555fad8d2290c1c158f87232ffd9e1", "revision": "ced6de63ca555fad8d2290c1c158f87232ffd9e1", "author_date": "2025-10-09T12:51:53Z", "commit_date": "2025-10-09T12:51:53Z", "message": "Changes to .bubby.yml", "committer": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1760014081477", "email": "john.doe@company.com", "admin": true, "workspace_owner": true }, "author": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1760014081477", "email": "john.doe@company.com", "admin": true, "workspace_owner": true } }, { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/commits/af0c5335900ab848c02a989690583074ed2cb7e9", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/commit/af0c5335900ab848c02a989690583074ed2cb7e9", "revision": "af0c5335900ab848c02a989690583074ed2cb7e9", "author_date": "2025-10-09T12:51:10Z", "commit_date": "2025-10-09T12:51:10Z", "message": "Changes to .bubby.yml", "committer": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1760014081477", "email": "john.doe@company.com", "admin": true, "workspace_owner": true }, "author": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1760014081477", "email": "john.doe@company.com", "admin": true, "workspace_owner": true } }, { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/commits/9a0b44ffc71c8e7d81f5daf1eab58e5c35102180", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/commit/9a0b44ffc71c8e7d81f5daf1eab58e5c35102180", "revision": "9a0b44ffc71c8e7d81f5daf1eab58e5c35102180", "author_date": "2025-10-09T12:49:45Z", "commit_date": "2025-10-09T12:49:45Z", "message": "Changes to .bubby.yml", "committer": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1760014081477", "email": "john.doe@company.com", "admin": true, "workspace_owner": true }, "author": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1760014081477", "email": "john.doe@company.com", "admin": true, "workspace_owner": true } } ], "base_commit": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/commits/15118345e2fda9855d3641e434158af5cee9b444", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/commit/15118345e2fda9855d3641e434158af5cee9b444", "revision": "15118345e2fda9855d3641e434158af5cee9b444", "author_date": "2025-10-09T12:48:38Z", "commit_date": "2025-10-09T12:48:38Z", "message": "Added .bubby.yml", "committer": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1760014081477", "email": "john.doe@company.com", "admin": true, "workspace_owner": true }, "author": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1760014081477", "email": "john.doe@company.com", "admin": true, "workspace_owner": true } }, "ahead": 0, "behind": 4 } } } } }, "security": [ { "oauth2": [ "REPOSITORY_READ" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/repository/contents": { "get": { "tags": [ "Project API" ], "summary": "Returns the contents of the repository for the specified revision or HEAD", "operationId": "getRepositoryContents", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "revision", "in": "query", "description": "The git revision (branch, tag, or commit) to retrieve contents from", "schema": { "type": "string", "example": "main" } } ], "responses": { "200": { "description": "Directory contents", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepositoryContentsView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/contents", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/content", "contents": [ { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/contents/src", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/content/%2Fsrc", "content_type": "DIR", "name": "src", "path": "/src" }, { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/contents/ala.txt", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/content/ala.txt", "content_type": "FILE", "encoding": "base64", "size": 10, "name": "ala.txt", "path": "ala.txt", "content": "77+977+977+9eg==" } ] } } } } }, "security": [ { "oauth2": [ "REPOSITORY_READ" ] } ] }, "post": { "tags": [ "Project API" ], "summary": "Creates a new file in the repository", "operationId": "commitNewFile", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommitNewFileRequest" }, "example": { "path": "docs/API.md", "content": "IyBBUEkgRG9jdW1lbnRhdGlvbgoKVGhpcyBkb2N1bWVudCBkZXNjcmliZXMgdGhlIEFQSS4=", "message": "Add API documentation", "branch": "main" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommittedFileView" }, "example": { "content": { "url": "https://api.app.buddy.works/workspaces/buddy/projects/company-website/repository/contents/docs/API.md?revision=88156f99f2b62a8250056e450b8f7b19f4da759f", "html_url": "https://app.buddy.works/buddy/company-website/repository/content/revision/88156f99f2b62a8250056e450b8f7b19f4da759f/docs%2FAPI.md", "content_type": "FILE", "encoding": "base64", "size": 53, "name": "API.md", "path": "docs/API.md", "content": "IyBBUEkgRG9jdW1lbnRhdGlvbgoKVGhpcyBkb2N1bWVudCBkZXNjcmliZXMgdGhlIEFQSS4=" }, "commit": { "url": "https://api.app.buddy.works/workspaces/buddy/projects/company-website/repository/commits/88156f99f2b62a8250056e450b8f7b19f4da759f", "html_url": "https://app.buddy.works/buddy/company-website/repository/commit/88156f99f2b62a8250056e450b8f7b19f4da759f", "revision": "88156f99f2b62a8250056e450b8f7b19f4da759f", "author_date": "2025-10-15T06:25:51Z", "commit_date": "2025-10-15T06:25:51Z", "message": "Add API documentation", "committer": { "url": "https://api.app.buddy.works/workspaces/buddy/members/1", "html_url": "https://app.buddy.works/buddy/profile/1", "id": 1, "name": "Mike Benson", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/1/c29ad88d-c0be-4f83-880a-c1aefa66e4f2/w/32/32/AVATAR.png", "title": "CEO" }, "author": { "url": "https://api.app.buddy.works/workspaces/buddy/members/1", "html_url": "https://app.buddy.works/buddy/profile/1", "id": 1, "name": "Mike Benson", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/1/c29ad88d-c0be-4f83-880a-c1aefa66e4f2/w/32/32/AVATAR.png", "title": "CEO" } } } } } } }, "security": [ { "oauth2": [ "REPOSITORY_WRITE" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/repository/contents/{path}": { "get": { "tags": [ "Project API" ], "summary": "Returns the contents of the repository for the specified revision or HEAD", "operationId": "getRepositoryContents_1", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "path", "in": "path", "description": "The path to the file in the repository", "required": true, "schema": { "pattern": ".+", "type": "string", "example": "src/main.js" } }, { "name": "revision", "in": "query", "description": "The git revision (branch, tag, or commit) to retrieve contents from", "schema": { "type": "string", "example": "main" } } ], "responses": { "200": { "description": "Returns directory contents or file content", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/RepositoryContentsView" }, { "$ref": "#/components/schemas/RepositoryContentView" } ] }, "examples": { "Directory contents": { "description": "Directory contents", "value": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/contents/src", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/content/src", "contents": [ { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/contents/src/main", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/content/%2Fsrc%2Fmain", "content_type": "DIR", "name": "main", "path": "/src/main" }, { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/contents/src/README.txt", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/content/src%2FREADME.txt", "content_type": "FILE", "encoding": "base64", "size": 12, "name": "README.txt", "path": "src/README.txt", "content": "c2FtcGxlIHZhbHVl" } ] } }, "File content": { "description": "File content", "value": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/contents/src/main/java/Main.java", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/content/src%2Fmain%2Fjava%2FMain.java", "content_type": "FILE", "encoding": "base64", "size": 117, "name": "Main.java", "path": "src/main/java/Main.java", "content": "cHVibGljIGNsYXNzIE1haW4gewogICAgcHVibGljIHN0YXRpYyB2b2lkIG1haW4oU3RyaW5nW10gYXJncykgewogICAgICAgIFN5c3RlbS5vdXQucHJpbnRsbigiSGVsbG8sIFdvcmxkISIpOwogICAgfQp9" } } } } } } }, "security": [ { "oauth2": [ "REPOSITORY_READ" ] } ] }, "put": { "tags": [ "Project API" ], "summary": "Updates an existing file in the repository", "operationId": "commitFileChanges", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "path", "in": "path", "description": "The path to the file in the repository", "required": true, "schema": { "pattern": ".+", "type": "string", "example": "src/main.js" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommitFileRequest" }, "example": { "content": "IyBBUEkgRG9jdW1lbnRhdGlvbgoKVGhpcyBkb2N1bWVudCBkZXNjcmliZXMgdGhlIEFQSSBlbmRwb2ludHMu", "message": "Update API documentation", "branch": "master" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommittedFileView" }, "example": { "content": { "url": "https://api.app.buddy.works/workspaces/buddy/projects/company-website/repository/contents/docs/API.md?revision=2693493ef0b31e0850e87e89a08d49953f012050", "html_url": "https://app.buddy.works/buddy/company-website/repository/content/revision/2693493ef0b31e0850e87e89a08d49953f012050/docs%2FAPI.md", "content_type": "FILE", "encoding": "base64", "size": 63, "name": "API.md", "path": "docs/API.md", "content": "IyBBUEkgRG9jdW1lbnRhdGlvbgoKVGhpcyBkb2N1bWVudCBkZXNjcmliZXMgdGhlIEFQSSBlbmRwb2ludHMu" }, "commit": { "url": "https://api.app.buddy.works/workspaces/buddy/projects/company-website/repository/commits/2693493ef0b31e0850e87e89a08d49953f012050", "html_url": "https://app.buddy.works/buddy/company-website/repository/commit/2693493ef0b31e0850e87e89a08d49953f012050", "revision": "2693493ef0b31e0850e87e89a08d49953f012050", "author_date": "2025-10-15T06:38:02Z", "commit_date": "2025-10-15T06:38:02Z", "message": "Update API documentation", "committer": { "url": "https://api.app.buddy.works/workspaces/buddy/members/1", "html_url": "https://app.buddy.works/buddy/profile/1", "id": 1, "name": "Mike Benson", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png", "title": "CEO" }, "author": { "url": "https://api.app.buddy.works/workspaces/buddy/members/1", "html_url": "https://app.buddy.works/buddy/profile/1", "id": 1, "name": "Mike Benson", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png", "title": "CEO" } } } } } } }, "security": [ { "oauth2": [ "REPOSITORY_WRITE" ] } ] }, "delete": { "tags": [ "Project API" ], "summary": "Deletes a file from the repository", "operationId": "deleteFile", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "path", "in": "path", "description": "The path to the file in the repository", "required": true, "schema": { "pattern": ".+", "type": "string", "example": "src/main.js" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommitRequest" }, "example": { "message": "Delete obsolete file", "branch": "main" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShortCommitView" }, "example": { "url": "https://api.app.buddy.works/workspaces/buddy/projects/company-website/repository/commits/fad3c573a6e856e37c5173bb52d71ba5c69729e2", "html_url": "https://app.buddy.works/buddy/company-website/repository/commit/fad3c573a6e856e37c5173bb52d71ba5c69729e2", "revision": "fad3c573a6e856e37c5173bb52d71ba5c69729e2", "author_date": "2025-10-15T06:54:38Z", "commit_date": "2025-10-15T06:54:38Z", "message": "Delete obsolete file", "committer": { "url": "https://api.app.buddy.works/workspaces/buddy/members/123", "html_url": "https://app.buddy.works/buddy/profile/123", "id": 123, "name": "Mike Benson", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/123/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png", "email": "mike.benson@company.com", "admin": true, "workspace_owner": true }, "author": { "url": "https://api.app.buddy.works/workspaces/buddy/members/123", "html_url": "https://app.buddy.works/buddy/profile/123", "id": 123, "name": "Mike Benson", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/123/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png", "email": "mike.benson@company.com", "admin": true, "workspace_owner": true } } } } } }, "security": [ { "oauth2": [ "REPOSITORY_WRITE" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/repository/pulls": { "get": { "tags": [ "Project API" ], "summary": "Returns list of pull requests in the repository", "operationId": "getPullRequests", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PullRequestsView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/pulls", "pull_requests": [ { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/pulls/5", "name": "pull/5", "number": 5, "github_html_url": "https://github.com/company/repo/pull/5" }, { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/pulls/2", "name": "pull/2", "number": 2, "github_html_url": "https://github.com/company/repo/pull/2" } ] } } } } }, "security": [ { "oauth2": [ "REPOSITORY_READ" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/repository/pulls/{number}": { "get": { "tags": [ "Project API" ], "summary": "Returns details of a single pull request", "operationId": "getPullRequest", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "number", "in": "path", "description": "The pull request number", "required": true, "schema": { "type": "integer", "format": "int32", "example": 5 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PullRequestView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/pulls/5", "name": "pull/5", "number": 5, "github_html_url": "https://github.com/company/repo/pull/5" } } } } }, "security": [ { "oauth2": [ "REPOSITORY_READ" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/repository/tags": { "get": { "tags": [ "Project API" ], "summary": "Returns list of tags in the repository", "operationId": "getTags", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagsView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/tags", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/tags", "tags": [ { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/tags/v2", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/tag/v2", "name": "v2" }, { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/tags/v1", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/tag/v1", "name": "v1" } ] } } } } }, "security": [ { "oauth2": [ "REPOSITORY_READ" ] } ] }, "post": { "tags": [ "Project API" ], "summary": "Creates a new tag in the repository", "operationId": "addTag", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTagRequest" }, "examples": { "Create lightweight tag": { "description": "Create lightweight tag", "value": { "name": "v1.3.0", "commit": { "revision": "abc123def456" } } }, "Create annotated tag with message": { "description": "Create annotated tag with message", "value": { "name": "v1.3.0", "commit": { "revision": "abc123def456" }, "message": "Release version 1.3.0" } } } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/tags/v2", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/tag/v2", "name": "v2", "commit": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/commits/ced6de63ca555fad8d2290c1c158f87232ffd9e1", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/commit/ced6de63ca555fad8d2290c1c158f87232ffd9e1", "revision": "ced6de63ca555fad8d2290c1c158f87232ffd9e1", "author_date": "2025-10-09T12:51:53Z", "commit_date": "2025-10-09T12:51:53Z", "message": "Changes to .bubby.yml", "committer": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1760014081477", "email": "john.doe@company.com", "admin": true, "workspace_owner": true }, "author": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1760014081477", "email": "john.doe@company.com", "admin": true, "workspace_owner": true } }, "message": "Version containing changes to user model" } } } } }, "security": [ { "oauth2": [ "REPOSITORY_WRITE" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/repository/tags/{name}": { "get": { "tags": [ "Project API" ], "summary": "Returns details of a single tag", "operationId": "getTag", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "name", "in": "path", "description": "The name of the tag", "required": true, "schema": { "type": "string", "example": "v1.0.0" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/tags/v2", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/tag/v2", "name": "v2", "commit": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/repository/commits/ced6de63ca555fad8d2290c1c158f87232ffd9e1", "html_url": "https://app.buddy.works/my-workspace/my-project/repository/commit/ced6de63ca555fad8d2290c1c158f87232ffd9e1", "revision": "ced6de63ca555fad8d2290c1c158f87232ffd9e1", "author_date": "2025-10-09T12:51:53Z", "commit_date": "2025-10-09T12:51:53Z", "message": "Changes to .bubby.yml", "committer": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1760014081477", "email": "john.doe@company.com", "admin": true, "workspace_owner": true }, "author": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1760014081477", "email": "john.doe@company.com", "admin": true, "workspace_owner": true } }, "message": "Version containing changes to user model" } } } } }, "security": [ { "oauth2": [ "REPOSITORY_READ" ] } ] }, "delete": { "tags": [ "Project API" ], "summary": "Deletes a tag from the repository", "operationId": "deleteTag", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "name", "in": "path", "description": "The name of the tag", "required": true, "schema": { "type": "string", "example": "v1.0.0" } } ], "responses": { "204": { "description": "Tag deleted successfully" } }, "security": [ { "oauth2": [ "REPOSITORY_WRITE" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/unit-tests/suites": { "get": { "tags": [ "Unit Test API" ], "summary": "Get all unit test suites for a project", "operationId": "getUnitTestSuites", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitTestSuitesView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites", "suites": [ { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites/65OmRb8v", "html_url": "https://app.buddy.works/my-workspace/my-project/unit-tests/65OmRb8v", "id": "65OmRb8v", "name": "Backend Integration Tests", "identifier": "backend-tests" }, { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites/ajnGBdJr", "html_url": "https://app.buddy.works/my-workspace/my-project/unit-tests/ajnGBdJr", "id": "ajnGBdJr", "name": "Frontend Unit Tests", "identifier": "frontend-tests" } ] } } } } }, "security": [ { "oauth2": [ "UNIT_TEST_INFO" ] } ] }, "post": { "tags": [ "Unit Test API" ], "summary": "Add a new unit test suite to a project", "operationId": "addUnitTestSuite", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "suite_id", "in": "path", "description": "The ID of the unit test suite", "required": true, "schema": { "type": "string", "example": "MNbyVedg" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddSuiteRequest" }, "examples": { "Add unit test suite": { "description": "Add unit test suite", "value": { "name": "Backend Integration Tests", "identifier": "backend-tests", "timeout": 3600, "error_pattern": "(ERROR|FATAL|Exception)", "slow_threshold": 5000 } } } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitTestSuiteView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites/65OmRb8v", "html_url": "https://app.buddy.works/my-workspace/my-project/unit-tests/65OmRb8v", "id": "65OmRb8v", "name": "Backend Integration Tests", "identifier": "backend-tests", "timeout": 3600, "error_pattern": "(ERROR|FATAL|Exception)", "token": "bud_ut_us_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5", "slow_threshold": 5000 } } } } }, "security": [ { "oauth2": [ "UNIT_TEST_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/unit-tests/suites/{id}": { "get": { "tags": [ "Unit Test API" ], "summary": "Get a specific unit test suite", "operationId": "getUnitTestSuite", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "id", "in": "path", "description": "The ID of the unit test suite", "required": true, "schema": { "type": "string", "example": "MNbyVedg" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitTestSuiteView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites/65OmRb8v", "html_url": "https://app.buddy.works/my-workspace/my-project/unit-tests/65OmRb8v", "id": "65OmRb8v", "name": "Backend Integration Tests", "identifier": "backend-tests", "timeout": 3600, "error_pattern": "(ERROR|FATAL|Exception)", "token": "bud_ut_us_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5", "slow_threshold": 5000 } } } } }, "security": [ { "oauth2": [ "UNIT_TEST_INFO" ] } ] }, "delete": { "tags": [ "Unit Test API" ], "summary": "Delete a unit test suite", "operationId": "deleteUnitTestSuite", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "id", "in": "path", "description": "The ID of the unit test suite", "required": true, "schema": { "type": "string", "example": "MNbyVedg" } } ], "responses": { "204": { "description": "Unit test suite deleted successfully" } }, "security": [ { "oauth2": [ "UNIT_TEST_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/unit-tests/suites/{suite_id}/sessions": { "get": { "tags": [ "Unit Test API" ], "summary": "Get all test sessions for a suite", "operationId": "getUnitTestSessions", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "suite_id", "in": "path", "description": "The ID of the unit test suite", "required": true, "schema": { "type": "string", "example": "MNbyVedg" } }, { "name": "page", "in": "query", "description": "The number of the successive pages (results are split into pages of per_page elements each).", "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "per_page", "in": "query", "description": "Specifies the number of returned elements on the page. The default value is 20.", "schema": { "type": "integer", "format": "int32", "example": 20 } }, { "name": "branch", "in": "query", "description": "Filter sessions by branch name", "schema": { "type": "string", "example": "main" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestSessionsView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites/MNbyVedg/sessions", "html_url": "https://app.buddy.works/my-workspace/my-project/unit-tests/MNbyVedg", "sessions": [ { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites/MNbyVedg/sessions/YDnagwGk", "html_url": "https://app.buddy.works/my-workspace/my-project/unit-tests/MNbyVedg/YDnagwGk", "id": "YDnagwGk", "relative_id": 2, "create_date": "2025-10-21T06:42:16Z", "start_date": "2025-10-21T06:42:16Z", "created_by": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1760014081477", "email": "john.doe@company.com", "admin": true, "workspace_owner": true }, "ci_provider": "BUDDY", "revision": "755b691cfff32e08aba35f2c9b1451ed76cfd583", "ref_type": "BRANCH", "ref_name": "master", "execution_id": "68f72b4466907cbc77887a08", "action_execution_id": "68f72b4466907cbc77887a0a", "status": "SUCCESSFUL", "duration": 0, "tests_count": 109, "failed_count": 0, "skipped_count": 0, "error_count": 0 }, { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites/MNbyVedg/sessions/r4nBYXVq", "html_url": "https://app.buddy.works/my-workspace/my-project/unit-tests/MNbyVedg/r4nBYXVq", "id": "r4nBYXVq", "relative_id": 1, "create_date": "2025-10-21T06:42:08Z", "start_date": "2025-10-21T06:42:08Z", "created_by": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1760014081477", "email": "john.doe@company.com", "admin": true, "workspace_owner": true }, "ci_provider": "BUDDY", "revision": "755b691cfff32e08aba35f2c9b1451ed76cfd583", "ref_type": "BRANCH", "ref_name": "master", "execution_id": "68f72b3d66907cbc77887986", "action_execution_id": "68f72b3d66907cbc77887988", "status": "SUCCESSFUL", "duration": 1, "tests_count": 109, "failed_count": 0, "skipped_count": 0, "error_count": 0 } ] } } } } }, "security": [ { "oauth2": [ "UNIT_TEST_INFO" ] } ] }, "post": { "tags": [ "Unit Test API" ], "summary": "Add a new test session to a suite", "operationId": "addUnitTestSession", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "suite_id", "in": "path", "description": "The ID of the unit test suite", "required": true, "schema": { "type": "string", "example": "MNbyVedg" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddSessionRequest" }, "examples": { "Add test session": { "description": "Add test session", "value": { "ci_provider": "GITHUB_ACTION", "revision": "b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1", "ref_type": "BRANCH", "ref_name": "main", "run_id": "12345678", "created_by": { "id": 123 } } } } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestSessionView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites/MNbyVedg/sessions/r4nBYXVq", "html_url": "https://app.buddy.works/my-workspace/my-project/unit-tests/MNbyVedg/r4nBYXVq", "id": "r4nBYXVq", "relative_id": 1, "create_date": "2025-10-21T06:42:08Z", "start_date": "2025-10-21T06:42:08Z", "created_by": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1760014081477", "email": "john.doe@company.com", "admin": true, "workspace_owner": true }, "ci_provider": "BUDDY", "revision": "755b691cfff32e08aba35f2c9b1451ed76cfd583", "ref_type": "BRANCH", "ref_name": "master", "execution_id": "68f72b3d66907cbc77887986", "action_execution_id": "68f72b3d66907cbc77887988", "status": "SUCCESSFUL", "duration": 1, "tests_count": 109, "failed_count": 0, "skipped_count": 0, "error_count": 0 } } } } }, "security": [ { "oauth2": [ "UNIT_TEST_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/unit-tests/suites/{suite_id}/sessions/{id}": { "get": { "tags": [ "Unit Test API" ], "summary": "Get a specific test session", "operationId": "getUnitTestSession", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "suite_id", "in": "path", "description": "The ID of the unit test suite", "required": true, "schema": { "type": "string", "example": "MNbyVedg" } }, { "name": "id", "in": "path", "description": "The ID of the test session", "required": true, "schema": { "type": "string", "example": "r4nBYXVq" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestSessionView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites/MNbyVedg/sessions/r4nBYXVq", "html_url": "https://app.buddy.works/my-workspace/my-project/unit-tests/MNbyVedg/r4nBYXVq", "id": "r4nBYXVq", "relative_id": 1, "create_date": "2025-10-21T06:42:08Z", "start_date": "2025-10-21T06:42:08Z", "created_by": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1760014081477", "email": "john.doe@company.com", "admin": true, "workspace_owner": true }, "ci_provider": "BUDDY", "revision": "755b691cfff32e08aba35f2c9b1451ed76cfd583", "ref_type": "BRANCH", "ref_name": "master", "execution_id": "68f72b3d66907cbc77887986", "action_execution_id": "68f72b3d66907cbc77887988", "status": "SUCCESSFUL", "duration": 1, "tests_count": 109, "failed_count": 0, "skipped_count": 0, "error_count": 0 } } } } }, "security": [ { "oauth2": [ "UNIT_TEST_INFO" ] } ] }, "delete": { "tags": [ "Unit Test API" ], "summary": "Delete a test session", "operationId": "deleteUnitTestSession", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "suite_id", "in": "path", "description": "The ID of the unit test suite", "required": true, "schema": { "type": "string", "example": "MNbyVedg" } }, { "name": "id", "in": "path", "description": "The ID of the test session", "required": true, "schema": { "type": "string", "example": "r4nBYXVq" } } ], "responses": { "204": { "description": "Test session deleted successfully" } }, "security": [ { "oauth2": [ "UNIT_TEST_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/unit-tests/suites/{suite_id}/sessions/{session_id}/cases": { "get": { "tags": [ "Unit Test API" ], "summary": "Get all test cases for a session", "operationId": "getSessionCases", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "suite_id", "in": "path", "description": "The ID of the unit test suite", "required": true, "schema": { "type": "string", "example": "MNbyVedg" } }, { "name": "session_id", "in": "path", "description": "The ID of the test session", "required": true, "schema": { "type": "string", "example": "r4nBYXVq" } }, { "name": "page", "in": "query", "description": "The number of the successive pages (results are split into pages of per_page elements each).", "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "per_page", "in": "query", "description": "Specifies the number of returned elements on the page. The default value is 20.", "schema": { "type": "integer", "format": "int32", "example": 20 } }, { "name": "status", "in": "query", "description": "Filter test cases by status", "schema": { "type": "string", "example": "PASSED", "enum": [ "PASSED", "FAILED", "SKIPPED", "ERROR" ] } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestCasesView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites/65OmRb8v/sessions/0eV0P3V7/cases", "html_url": "https://app.buddy.works/my-workspace/my-project/unit-tests/65OmRb8v/0eV0P3V7", "cases": [ { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites/65OmRb8v/sessions/0eV0P3V7/test-groups/68f0a5e6b46c1345dfc9bc3a/cases/68f0a5e6b46c1345dfc9bc3b", "html_url": "https://app.buddy.works/my-workspace/my-project/unit-tests/65OmRb8v/0eV0P3V7", "id": "68f0a5e6b46c1345dfc9bc3b", "name": "testSkipped", "test_group_name": "com.example.PaymentServiceTest", "test_group_id": "68f0a5e6b46c1345dfc9bc3a", "classname": "com.example.PaymentServiceTest", "status": "SKIPPED", "time": 0 }, { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites/65OmRb8v/sessions/0eV0P3V7/test-groups/68f0a5e6b46c1345dfc9bc37/cases/68f0a5e6b46c1345dfc9bc39", "html_url": "https://app.buddy.works/my-workspace/my-project/unit-tests/65OmRb8v/0eV0P3V7", "id": "68f0a5e6b46c1345dfc9bc39", "name": "testShouldHandleError", "test_group_name": "com.example.UserServiceTest", "test_group_id": "68f0a5e6b46c1345dfc9bc37", "classname": "com.example.UserServiceTest", "status": "FAILED", "time": 0.456 }, { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites/65OmRb8v/sessions/0eV0P3V7/test-groups/68f0a5e6b46c1345dfc9bc37/cases/68f0a5e6b46c1345dfc9bc38", "html_url": "https://app.buddy.works/my-workspace/my-project/unit-tests/65OmRb8v/0eV0P3V7", "id": "68f0a5e6b46c1345dfc9bc38", "name": "testShouldReturnSuccess", "test_group_name": "com.example.UserServiceTest", "test_group_id": "68f0a5e6b46c1345dfc9bc37", "classname": "com.example.UserServiceTest", "status": "PASSED", "time": 0.123 }, { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites/65OmRb8v/sessions/0eV0P3V7/test-groups/68f0a5d8b46c1345dfc9bbfd/cases/68f0a5d8b46c1345dfc9bbfe", "html_url": "https://app.buddy.works/my-workspace/my-project/unit-tests/65OmRb8v/0eV0P3V7", "id": "68f0a5d8b46c1345dfc9bbfe", "name": "FormInput", "test_group_name": "src/components/src/components/form/input.test.tsx", "test_group_id": "68f0a5d8b46c1345dfc9bbfd", "classname": "src/components/src/components/form/input.test.tsx", "status": "PASSED", "time": 0.061 }, { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites/65OmRb8v/sessions/0eV0P3V7/test-groups/68f0a5d8b46c1345dfc9bbff/cases/68f0a5d8b46c1345dfc9bc00", "html_url": "https://app.buddy.works/my-workspace/my-project/unit-tests/65OmRb8v/0eV0P3V7", "id": "68f0a5d8b46c1345dfc9bc00", "name": "Wrapper", "test_group_name": "src/components/src/components/wrapper/wrapper.test.tsx", "test_group_id": "68f0a5d8b46c1345dfc9bbff", "classname": "src/components/src/components/wrapper/wrapper.test.tsx", "status": "PASSED", "time": 0.085 } ] } } } } }, "security": [ { "oauth2": [ "UNIT_TEST_INFO" ] } ] }, "put": { "tags": [ "Unit Test API" ], "summary": "Add or update a test case", "operationId": "upsertUnitTestCase", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "suite_id", "in": "path", "description": "The ID of the unit test suite", "required": true, "schema": { "type": "string", "example": "MNbyVedg" } }, { "name": "session_id", "in": "path", "description": "The ID of the test session", "required": true, "schema": { "type": "string", "example": "r4nBYXVq" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddTestCaseRequest" }, "example": { "name": "testUserLogin", "test_group_name": "com.example.tests.IntegrationTests", "classname": "com.example.tests.IntegrationTests", "status": "PASSED", "time": 2.5, "data": "" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestCaseView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites/5ddb7c180fb38be67bd78a88a/sessions/5ddb7c180fb38be67bd78a88b/test-groups/com.example.tests.IntegrationTests/cases/com.example.tests.IntegrationTests.testUserLogin", "html_url": "https://app.buddy.works/my-workspace/projects/my-project/unit-tests/suites/5ddb7c180fb38be67bd78a88a/sessions/5ddb7c180fb38be67bd78a88b/test-groups/com.example.tests.IntegrationTests/cases/com.example.tests.IntegrationTests.testUserLogin", "id": "com.example.tests.IntegrationTests.testUserLogin", "name": "testUserLogin", "test_group_name": "com.example.tests.IntegrationTests", "test_group_id": "com.example.tests.IntegrationTests", "classname": "com.example.tests.IntegrationTests", "status": "PASSED", "time": 2.5, "data": "" } } } }, "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestCaseView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites/5ddb7c180fb38be67bd78a88a/sessions/5ddb7c180fb38be67bd78a88b/test-groups/com.example.tests.IntegrationTests/cases/com.example.tests.IntegrationTests.testUserLogin", "html_url": "https://app.buddy.works/my-workspace/projects/my-project/unit-tests/suites/5ddb7c180fb38be67bd78a88a/sessions/5ddb7c180fb38be67bd78a88b/test-groups/com.example.tests.IntegrationTests/cases/com.example.tests.IntegrationTests.testUserLogin", "id": "com.example.tests.IntegrationTests.testUserLogin", "name": "testUserLogin", "test_group_name": "com.example.tests.IntegrationTests", "test_group_id": "com.example.tests.IntegrationTests", "classname": "com.example.tests.IntegrationTests", "status": "PASSED", "time": 2.5, "data": "" } } } } }, "security": [ { "oauth2": [ "UNIT_TEST_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/unit-tests/suites/{suite_id}/sessions/{session_id}/close": { "post": { "tags": [ "Unit Test API" ], "summary": "Close a test session", "operationId": "closeUnitTestSession", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "suite_id", "in": "path", "description": "The ID of the unit test suite", "required": true, "schema": { "type": "string", "example": "MNbyVedg" } }, { "name": "session_id", "in": "path", "description": "The ID of the test session", "required": true, "schema": { "type": "string", "example": "r4nBYXVq" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestSessionView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites/MNbyVedg/sessions/r4nBYXVq", "html_url": "https://app.buddy.works/my-workspace/my-project/unit-tests/MNbyVedg/r4nBYXVq", "id": "r4nBYXVq", "relative_id": 1, "create_date": "2025-10-21T06:42:08Z", "start_date": "2025-10-21T06:42:08Z", "created_by": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1760014081477", "email": "john.doe@company.com", "admin": true, "workspace_owner": true }, "ci_provider": "BUDDY", "revision": "755b691cfff32e08aba35f2c9b1451ed76cfd583", "ref_type": "BRANCH", "ref_name": "master", "execution_id": "68f72b3d66907cbc77887986", "action_execution_id": "68f72b3d66907cbc77887988", "status": "SUCCESSFUL", "duration": 1, "tests_count": 109, "failed_count": 0, "skipped_count": 0, "error_count": 0 } } } } }, "security": [ { "oauth2": [ "UNIT_TEST_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/unit-tests/suites/{suite_id}/sessions/{session_id}/reopen": { "post": { "tags": [ "Unit Test API" ], "summary": "Reopen a closed test session", "operationId": "reopenUnitTestSession", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "suite_id", "in": "path", "description": "The ID of the unit test suite", "required": true, "schema": { "type": "string", "example": "MNbyVedg" } }, { "name": "session_id", "in": "path", "description": "The ID of the test session", "required": true, "schema": { "type": "string", "example": "r4nBYXVq" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestSessionView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites/MNbyVedg/sessions/r4nBYXVq", "html_url": "https://app.buddy.works/my-workspace/my-project/unit-tests/MNbyVedg/r4nBYXVq", "id": "r4nBYXVq", "relative_id": 1, "create_date": "2025-10-21T06:42:08Z", "start_date": "2025-10-21T06:42:08Z", "created_by": { "url": "https://api.buddy.works/workspaces/my-workspace/members/1", "html_url": "https://app.buddy.works/my-workspace/-/profile/1", "id": 1, "name": "John Doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png?ts=1760014081477", "email": "john.doe@company.com", "admin": true, "workspace_owner": true }, "ci_provider": "BUDDY", "revision": "755b691cfff32e08aba35f2c9b1451ed76cfd583", "ref_type": "BRANCH", "ref_name": "master", "execution_id": "68f72b3d66907cbc77887986", "action_execution_id": "68f72b3d66907cbc77887988", "status": "SUCCESSFUL", "duration": 1, "tests_count": 109, "failed_count": 0, "skipped_count": 0, "error_count": 0 } } } } }, "security": [ { "oauth2": [ "UNIT_TEST_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/unit-tests/suites/{suite_id}/sessions/{session_id}/test-groups": { "get": { "tags": [ "Unit Test API" ], "summary": "Get all test groups for a session", "operationId": "getUnitTestGroups", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "suite_id", "in": "path", "description": "The ID of the unit test suite", "required": true, "schema": { "type": "string", "example": "MNbyVedg" } }, { "name": "session_id", "in": "path", "description": "The ID of the test session", "required": true, "schema": { "type": "string", "example": "r4nBYXVq" } }, { "name": "page", "in": "query", "description": "The number of the successive pages (results are split into pages of per_page elements each).", "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "per_page", "in": "query", "description": "Specifies the number of returned elements on the page. The default value is 20.", "schema": { "type": "integer", "format": "int32", "example": 20 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestGroupsView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites/65OmRb8v/sessions/0eV0P3V7/test-groups", "html_url": "https://app.buddy.works/my-workspace/my-project/unit-tests/65OmRb8v/0eV0P3V7", "test_groups": [ { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites/65OmRb8v/sessions/0eV0P3V7/test-groups/68f0a5e6b46c1345dfc9bc37", "html_url": "https://app.buddy.works/my-workspace/my-project/unit-tests/65OmRb8v/0eV0P3V7", "id": "68f0a5e6b46c1345dfc9bc37", "name": "com.example.UserServiceTest", "time": 0.579, "tests_count": 2, "failed_count": 1, "skipped_count": 0, "error_count": 0, "status": "FAILED" }, { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites/65OmRb8v/sessions/0eV0P3V7/test-groups/68f0a5e6b46c1345dfc9bc3a", "html_url": "https://app.buddy.works/my-workspace/my-project/unit-tests/65OmRb8v/0eV0P3V7", "id": "68f0a5e6b46c1345dfc9bc3a", "name": "com.example.PaymentServiceTest", "time": 0, "tests_count": 1, "failed_count": 0, "skipped_count": 1, "error_count": 0, "status": "SKIPPED" }, { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites/65OmRb8v/sessions/0eV0P3V7/test-groups/68f0a5d8b46c1345dfc9bbfd", "html_url": "https://app.buddy.works/my-workspace/my-project/unit-tests/65OmRb8v/0eV0P3V7", "id": "68f0a5d8b46c1345dfc9bbfd", "name": "src/components/src/components/form/input.test.tsx", "time": 0.061, "tests_count": 1, "failed_count": 0, "skipped_count": 0, "error_count": 0, "status": "PASSED" } ] } } } } }, "security": [ { "oauth2": [ "UNIT_TEST_INFO" ] } ] }, "post": { "tags": [ "Unit Test API" ], "summary": "Add a new test group to a session", "operationId": "addUnitTestGroup", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "suite_id", "in": "path", "description": "The ID of the unit test suite", "required": true, "schema": { "type": "string", "example": "MNbyVedg" } }, { "name": "session_id", "in": "path", "description": "The ID of the test session", "required": true, "schema": { "type": "string", "example": "r4nBYXVq" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddTestGroupRequest" }, "examples": { "Add test group": { "description": "Add test group", "value": { "name": "com.example.tests.IntegrationTests" } } } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestGroupView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites/65OmRb8v/sessions/0eV0P3V7/test-groups/68f0a5d8b46c1345dfc9bbed", "html_url": "https://app.buddy.works/my-workspace/my-project/unit-tests/65OmRb8v/0eV0P3V7", "id": "68f0a5d8b46c1345dfc9bbed", "name": "src/utils/path/joinPath.test.ts", "time": 0.009, "tests_count": 12, "failed_count": 0, "skipped_count": 0, "error_count": 0, "status": "PASSED" } } } } }, "security": [ { "oauth2": [ "UNIT_TEST_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/unit-tests/suites/{suite_id}/sessions/{session_id}/test-groups/{id}": { "get": { "tags": [ "Unit Test API" ], "summary": "Get a specific test group", "operationId": "getUnitTestGroup", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "suite_id", "in": "path", "description": "The ID of the unit test suite", "required": true, "schema": { "type": "string", "example": "MNbyVedg" } }, { "name": "session_id", "in": "path", "description": "The ID of the test session", "required": true, "schema": { "type": "string", "example": "r4nBYXVq" } }, { "name": "id", "in": "path", "description": "The ID of the test group", "required": true, "schema": { "type": "string", "example": "com.example.tests.IntegrationTests" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestGroupView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites/65OmRb8v/sessions/0eV0P3V7/test-groups/68f0a5d8b46c1345dfc9bbed", "html_url": "https://app.buddy.works/my-workspace/my-project/unit-tests/65OmRb8v/0eV0P3V7", "id": "68f0a5d8b46c1345dfc9bbed", "name": "src/utils/path/joinPath.test.ts", "time": 0.009, "tests_count": 12, "failed_count": 0, "skipped_count": 0, "error_count": 0, "status": "PASSED" } } } } }, "security": [ { "oauth2": [ "UNIT_TEST_INFO" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/unit-tests/suites/{suite_id}/sessions/{session_id}/test-groups/{test_group_id}/cases": { "get": { "tags": [ "Unit Test API" ], "summary": "Get all test cases for a test group", "operationId": "getUnitTestCases", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "suite_id", "in": "path", "description": "The ID of the unit test suite", "required": true, "schema": { "type": "string", "example": "MNbyVedg" } }, { "name": "session_id", "in": "path", "description": "The ID of the test session", "required": true, "schema": { "type": "string", "example": "r4nBYXVq" } }, { "name": "test_group_id", "in": "path", "description": "The ID of the test group", "required": true, "schema": { "type": "string", "example": "com.example.tests.IntegrationTests" } }, { "name": "page", "in": "query", "description": "The number of the successive pages (results are split into pages of per_page elements each).", "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "per_page", "in": "query", "description": "Specifies the number of returned elements on the page. The default value is 20.", "schema": { "type": "integer", "format": "int32", "example": 20 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestCasesView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites/65OmRb8v/sessions/0eV0P3V7/cases", "html_url": "https://app.buddy.works/my-workspace/my-project/unit-tests/65OmRb8v/0eV0P3V7", "cases": [ { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites/65OmRb8v/sessions/0eV0P3V7/test-groups/68f0a5e6b46c1345dfc9bc3a/cases/68f0a5e6b46c1345dfc9bc3b", "html_url": "https://app.buddy.works/my-workspace/my-project/unit-tests/65OmRb8v/0eV0P3V7", "id": "68f0a5e6b46c1345dfc9bc3b", "name": "testSkipped", "test_group_name": "com.example.PaymentServiceTest", "test_group_id": "68f0a5e6b46c1345dfc9bc3a", "classname": "com.example.PaymentServiceTest", "status": "SKIPPED", "time": 0 }, { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites/65OmRb8v/sessions/0eV0P3V7/test-groups/68f0a5e6b46c1345dfc9bc37/cases/68f0a5e6b46c1345dfc9bc39", "html_url": "https://app.buddy.works/my-workspace/my-project/unit-tests/65OmRb8v/0eV0P3V7", "id": "68f0a5e6b46c1345dfc9bc39", "name": "testShouldHandleError", "test_group_name": "com.example.UserServiceTest", "test_group_id": "68f0a5e6b46c1345dfc9bc37", "classname": "com.example.UserServiceTest", "status": "FAILED", "time": 0.456 }, { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites/65OmRb8v/sessions/0eV0P3V7/test-groups/68f0a5e6b46c1345dfc9bc37/cases/68f0a5e6b46c1345dfc9bc38", "html_url": "https://app.buddy.works/my-workspace/my-project/unit-tests/65OmRb8v/0eV0P3V7", "id": "68f0a5e6b46c1345dfc9bc38", "name": "testShouldReturnSuccess", "test_group_name": "com.example.UserServiceTest", "test_group_id": "68f0a5e6b46c1345dfc9bc37", "classname": "com.example.UserServiceTest", "status": "PASSED", "time": 0.123 }, { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites/65OmRb8v/sessions/0eV0P3V7/test-groups/68f0a5d8b46c1345dfc9bbfd/cases/68f0a5d8b46c1345dfc9bbfe", "html_url": "https://app.buddy.works/my-workspace/my-project/unit-tests/65OmRb8v/0eV0P3V7", "id": "68f0a5d8b46c1345dfc9bbfe", "name": "FormInput", "test_group_name": "src/components/src/components/form/input.test.tsx", "test_group_id": "68f0a5d8b46c1345dfc9bbfd", "classname": "src/components/src/components/form/input.test.tsx", "status": "PASSED", "time": 0.061 }, { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites/65OmRb8v/sessions/0eV0P3V7/test-groups/68f0a5d8b46c1345dfc9bbff/cases/68f0a5d8b46c1345dfc9bc00", "html_url": "https://app.buddy.works/my-workspace/my-project/unit-tests/65OmRb8v/0eV0P3V7", "id": "68f0a5d8b46c1345dfc9bc00", "name": "Wrapper", "test_group_name": "src/components/src/components/wrapper/wrapper.test.tsx", "test_group_id": "68f0a5d8b46c1345dfc9bbff", "classname": "src/components/src/components/wrapper/wrapper.test.tsx", "status": "PASSED", "time": 0.085 } ] } } } } }, "security": [ { "oauth2": [ "UNIT_TEST_INFO" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/unit-tests/suites/{suite_id}/sessions/{session_id}/test-groups/{test_group_id}/cases/{id}": { "get": { "tags": [ "Unit Test API" ], "summary": "Get a specific test case", "operationId": "getUnitTestCase", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "suite_id", "in": "path", "description": "The ID of the unit test suite", "required": true, "schema": { "type": "string", "example": "MNbyVedg" } }, { "name": "session_id", "in": "path", "description": "The ID of the test session", "required": true, "schema": { "type": "string", "example": "r4nBYXVq" } }, { "name": "test_group_id", "in": "path", "description": "The ID of the test group", "required": true, "schema": { "type": "string", "example": "com.example.tests.IntegrationTests" } }, { "name": "id", "in": "path", "description": "The ID of the test case", "required": true, "schema": { "type": "string", "example": "com.example.tests.IntegrationTests.testUserLogin" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestCaseView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/unit-tests/suites/5ddb7c180fb38be67bd78a88a/sessions/5ddb7c180fb38be67bd78a88b/test-groups/com.example.tests.IntegrationTests/cases/com.example.tests.IntegrationTests.testUserLogin", "html_url": "https://app.buddy.works/my-workspace/projects/my-project/unit-tests/suites/5ddb7c180fb38be67bd78a88a/sessions/5ddb7c180fb38be67bd78a88b/test-groups/com.example.tests.IntegrationTests/cases/com.example.tests.IntegrationTests.testUserLogin", "id": "com.example.tests.IntegrationTests.testUserLogin", "name": "testUserLogin", "test_group_name": "com.example.tests.IntegrationTests", "test_group_id": "com.example.tests.IntegrationTests", "classname": "com.example.tests.IntegrationTests", "status": "PASSED", "time": 2.5, "data": "" } } } } }, "security": [ { "oauth2": [ "UNIT_TEST_INFO" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/unit-tests/suites/{suite_id}/token": { "get": { "tags": [ "Unit Test API" ], "summary": "Get unit test suite token", "operationId": "getUnitTestSuiteToken", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "suite_id", "in": "path", "description": "The ID of the unit test suite", "required": true, "schema": { "type": "string", "example": "MNbyVedg" } } ], "responses": { "default": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/String" } } } } }, "security": [ { "oauth2": [ "UNIT_TEST_INFO" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/visual-tests/suites": { "get": { "tags": [ "Visual Test API" ], "summary": "Get all visual test suites for a project", "operationId": "getSuites_1", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VisualTestSuitesView" } } } } }, "security": [ { "oauth2": [ "VISUAL_TEST_INFO" ] } ] }, "post": { "tags": [ "Visual Test API" ], "summary": "Add a new visual test suite to a project", "operationId": "addSuite_1", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddVisualTestSuiteRequest" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VisualTestSuiteView" } } } } }, "security": [ { "oauth2": [ "VISUAL_TEST_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/visual-tests/suites/{suite_id}": { "delete": { "tags": [ "Visual Test API" ], "summary": "Delete a visual test suite", "operationId": "deleteSuite_1", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "suite_id", "in": "path", "description": "The ID of the visual test suite", "required": true, "schema": { "type": "string", "example": "MNbyVedg" } } ], "responses": { "204": { "description": "Visual test suite deleted successfully" } }, "security": [ { "oauth2": [ "VISUAL_TEST_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/projects/{project_name}/visual-tests/suites/{suite_id}/token": { "get": { "tags": [ "Visual Test API" ], "summary": "Get visual test suite token", "operationId": "getToken_3", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "path", "description": "The human-readable ID of the project", "required": true, "schema": { "type": "string", "example": "my-project" } }, { "name": "suite_id", "in": "path", "description": "The ID of the visual test suite", "required": true, "schema": { "type": "string", "example": "MNbyVedg" } } ], "responses": { "default": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/String" } } } } }, "security": [ { "oauth2": [ "VISUAL_TEST_INFO" ] } ] } }, "/workspaces/{workspace_domain}/sandboxes": { "get": { "tags": [ "Sandbox API" ], "summary": "Get all sandboxes in the workspace for a specific project", "operationId": "getSandboxes", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "query", "description": "The human-readable ID of the project to filter sandboxes", "required": true, "schema": { "type": "string", "example": "my-project" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxesView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/sandboxes", "html_url": "https://app.buddy.works/my-workspace/my-project/sandboxes", "sandboxes": [ { "url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-12345", "html_url": "https://app.buddy.works/my-workspace/my-project/sandboxes/sb-12345", "id": "sb-12345", "identifier": "my-api-sandbox", "name": "My API Development Sandbox", "status": "RUNNING", "setup_status": "INPROGRESS" }, { "url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-67890", "html_url": "https://app.buddy.works/my-workspace/my-project/sandboxes/sb-67890", "id": "sb-67890", "identifier": "test-environment", "name": "Test Environment Sandbox", "status": "STOPPED", "setup_status": "SUCCESS" } ] } } } } }, "security": [ { "oauth2": [ "SANDBOX_INFO" ] } ] }, "post": { "tags": [ "Sandbox API" ], "summary": "Create a new sandbox", "operationId": "addSandbox", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "query", "description": "The human-readable ID of the project to filter sandboxes", "required": true, "schema": { "type": "string", "example": "my-project" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CloneSandboxRequest" }, { "$ref": "#/components/schemas/CreateFromSnapshotRequest" }, { "$ref": "#/components/schemas/CreateNewSandboxRequest" } ] }, "examples": { "Clone existing sandbox": { "description": "Clone existing sandbox", "value": { "source_sandbox_id": "ghwmnj2az2k67", "name": "My cloned sandbox", "identifier": "cloned-sandbox" } }, "Create sandbox from existing snapshot": { "description": "Create sandbox from existing snapshot", "value": { "snapshot_id": "snapshot-456", "name": "From snapshot", "identifier": "snapshot-sandbox", "os": "ubuntu:24.04", "resources": "2x4", "first_boot_commands": "npm install", "apps": [ "npm start" ] } }, "Create completely new sandbox": { "description": "Create completely new sandbox", "value": { "name": "New sandbox", "identifier": "new_sandbox", "os": "ubuntu:24.04", "resources": "2x4", "first_boot_commands": "npm install && npm run build", "apps": [ "npm start", "npm run worker" ], "app_dir": "/app", "timeout": 3600, "tags": [ "development", "api", "nodejs" ], "endpoints": [ { "name": "www", "endpoint": "80", "type": "HTTP", "region": "EU", "whitelist": [ "192.168.1.0/24", "10.0.0.0/8" ], "timeout": 30, "http": { "verify_certificate": true, "compression": true, "http2": true, "log_requests": true, "request_headers": { "X-Forwarded-For": "wp.pl", "X-Real-IP": "127.0.0.1" }, "response_headers": { "X-Frame-Options": "DENY", "X-Content-Type-Options": "nosniff" }, "login": "api-user", "password": "secure-password-123", "circuit_breaker": 5, "serve_path": "/api" } }, { "name": "secure_api", "endpoint": "443", "type": "TLS", "region": "EU", "timeout": 60, "tls": { "private_key": "-----BEGIN PRIVATE KEY----------END PRIVATE KEY-----", "certificate": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", "ca_certificate": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", "terminate_at": "REGION" } } ], "variables": [ { "key": "my_var", "value": "some_value", "type": "VAR", "description": "a sandbox variable" } ], "permissions": { "others": "READ_ONLY", "users": [ { "id": 42, "access_level": "READ_WRITE" }, { "id": 100, "access_level": "MANAGE" } ], "groups": [ { "id": 10, "access_level": "READ_WRITE" } ] } } } } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxResponse" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-12345", "html_url": "https://app.buddy.works/sandboxes/sb-12345", "id": "sb-12345", "identifier": "my-api-sandbox", "name": "My API Development Sandbox", "status": "RUNNING", "source_sandbox_id": null, "snapshot_id": null, "os": "ubuntu:24.04", "resources": "2x4", "first_boot_commands": "npm install && npm run build", "app_dir": "/app", "apps": [ { "id": "a1b2c3d", "command": "npm start", "app_status": "RUNNING" } ], "timeout": 3600, "tags": [ "development", "api", "nodejs" ], "boot_logs": [ "Starting sandbox...", "Installing dependencies...", "npm install completed successfully", "Building application...", "Application ready on port 3000" ], "setup_status": "SUCCESS", "endpoints": [ { "name": "www", "endpoint": "80", "type": "HTTP", "region": "EU", "whitelist": [ "192.168.1.0/24" ], "timeout": 30, "http": { "endpoint_url": "https://www-my-api-sandbox-proj1757492386363-my-workspace.eu-1.buddy.app", "verify_certificate": true, "compression": true, "http2": true, "log_requests": true, "request_headers": { "X-Forwarded-For": "wp.pl" }, "response_headers": { "X-Frame-Options": "DENY" }, "circuit_breaker": 5, "serve_path": "/api" } } ], "project": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/proj1757492386363", "html_url": "https://app.buddy.works/proj1757492386363", "name": "proj1757492386363", "display_name": "proj1757492386363", "status": "ACTIVE" }, "variables": [ { "key": "my_var", "value": "some_value", "type": "VAR", "description": "a sandbox variable" } ], "permissions": { "others": "READ_ONLY", "users": [ { "id": 42, "access_level": "READ_WRITE" } ], "groups": [ { "id": 10, "access_level": "READ_WRITE" } ] } } } } } }, "security": [ { "oauth2": [ "SANDBOX_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/sandboxes/{id}": { "get": { "tags": [ "Sandbox API" ], "summary": "Get a specific sandbox by ID", "operationId": "getSandbox", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "id", "in": "path", "description": "The ID of the sandbox", "required": true, "schema": { "type": "string", "example": "sb-1234567890abcdef" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxResponse" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-12345", "html_url": "https://app.buddy.works/sandboxes/sb-12345", "id": "sb-12345", "identifier": "my-api-sandbox", "name": "My API Development Sandbox", "status": "RUNNING", "source_sandbox_id": null, "snapshot_id": null, "os": "ubuntu:24.04", "resources": "2x4", "first_boot_commands": "npm install && npm run build", "app_dir": "/app", "apps": [ { "id": "a1b2c3d", "command": "npm start", "app_status": "RUNNING" } ], "timeout": 3600, "tags": [ "development", "api", "nodejs" ], "boot_logs": [ "Starting sandbox...", "Installing dependencies...", "npm install completed successfully", "Building application...", "Application ready on port 3000" ], "setup_status": "SUCCESS", "endpoints": [ { "name": "www", "endpoint": "80", "type": "HTTP", "region": "EU", "whitelist": [ "192.168.1.0/24" ], "timeout": 30, "http": { "endpoint_url": "https://www-my-api-sandbox-proj1757492386363-my-workspace.eu-1.buddy.app", "verify_certificate": true, "compression": true, "http2": true, "log_requests": true, "request_headers": { "X-Forwarded-For": "wp.pl" }, "response_headers": { "X-Frame-Options": "DENY" }, "circuit_breaker": 5, "serve_path": "/api" } } ], "project": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/proj1757492386363", "html_url": "https://app.buddy.works/proj1757492386363", "name": "proj1757492386363", "display_name": "proj1757492386363", "status": "ACTIVE" }, "variables": [ { "key": "my_var", "value": "some_value", "type": "VAR", "description": "a sandbox variable" } ], "permissions": { "others": "READ_ONLY", "users": [ { "id": 42, "access_level": "READ_WRITE" } ], "groups": [ { "id": 10, "access_level": "READ_WRITE" } ] } } } } } }, "security": [ { "oauth2": [ "SANDBOX_INFO" ] } ] }, "delete": { "tags": [ "Sandbox API" ], "summary": "Delete a sandbox", "operationId": "deleteSandbox", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "id", "in": "path", "description": "The ID of the sandbox", "required": true, "schema": { "type": "string", "example": "sb-1234567890abcdef" } } ], "responses": { "204": { "description": "Sandbox deleted successfully" } }, "security": [ { "oauth2": [ "SANDBOX_MANAGE" ] } ] }, "patch": { "tags": [ "Sandbox API" ], "summary": "Update sandbox configuration", "operationId": "updateSandbox", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "id", "in": "path", "description": "The ID of the sandbox", "required": true, "schema": { "type": "string", "example": "sb-1234567890abcdef" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSandboxRequest" }, "examples": { "Update sandbox configuration": { "description": "Update sandbox configuration", "value": { "name": "Updated sandbox name", "os": "ubuntu:24.04", "resources": "4x8", "first_boot_commands": "npm install && npm run build && npm test", "apps": [ "npm run start:prod" ], "app_dir": "/app/dist", "timeout": 7200, "tags": [ "production", "api", "nodejs", "optimized" ], "endpoints": [ { "name": "api", "endpoint": "3000", "type": "HTTP", "region": "EU", "whitelist": [ "192.168.1.0/24", "10.0.0.0/8", "172.16.0.0/12" ], "timeout": 45, "http": { "verify_certificate": true, "compression": true, "http2": true, "log_requests": false, "request_headers": { "X-Forwarded-For": "updated.domain.pl", "X-Real-IP": "127.0.0.1", "Cache-Control": "no-cache" }, "response_headers": { "X-Frame-Options": "SAMEORIGIN", "X-Content-Type-Options": "nosniff", "Strict-Transport-Security": "max-age=31536000" }, "login": "updated-api-user", "password": "new-secure-password-456", "circuit_breaker": 3, "serve_path": "/v2/api" } }, { "name": "monitoring", "endpoint": "9090", "type": "HTTP", "region": "EU", "timeout": 15, "http": { "verify_certificate": false, "compression": false, "serve_path": "/metrics" } } ], "variables": [ { "key": "my_var", "value": "some_value", "type": "VAR", "description": "a sandbox variable" } ], "permissions": { "others": "DENIED", "users": [ { "id": 42, "access_level": "MANAGE" }, { "id": 55, "access_level": "READ_WRITE" } ], "groups": [ { "id": 10, "access_level": "READ_WRITE" }, { "id": 20, "access_level": "READ_ONLY" } ] } } }, "Update sandbox name only": { "description": "Update sandbox name only", "value": { "name": "My Renamed Sandbox" } } } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxResponse" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-12345", "html_url": "https://app.buddy.works/sandboxes/sb-12345", "id": "sb-12345", "identifier": "my-api-sandbox", "name": "My API Development Sandbox", "status": "RUNNING", "source_sandbox_id": null, "snapshot_id": null, "os": "ubuntu:24.04", "resources": "2x4", "first_boot_commands": "npm install && npm run build", "app_dir": "/app", "apps": [ { "id": "a1b2c3d", "command": "npm start", "app_status": "RUNNING" } ], "timeout": 3600, "tags": [ "development", "api", "nodejs" ], "boot_logs": [ "Starting sandbox...", "Installing dependencies...", "npm install completed successfully", "Building application...", "Application ready on port 3000" ], "setup_status": "SUCCESS", "endpoints": [ { "name": "www", "endpoint": "80", "type": "HTTP", "region": "EU", "whitelist": [ "192.168.1.0/24" ], "timeout": 30, "http": { "endpoint_url": "https://www-my-api-sandbox-proj1757492386363-my-workspace.eu-1.buddy.app", "verify_certificate": true, "compression": true, "http2": true, "log_requests": true, "request_headers": { "X-Forwarded-For": "wp.pl" }, "response_headers": { "X-Frame-Options": "DENY" }, "circuit_breaker": 5, "serve_path": "/api" } } ], "project": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/proj1757492386363", "html_url": "https://app.buddy.works/proj1757492386363", "name": "proj1757492386363", "display_name": "proj1757492386363", "status": "ACTIVE" }, "variables": [ { "key": "my_var", "value": "some_value", "type": "VAR", "description": "a sandbox variable" } ], "permissions": { "others": "READ_ONLY", "users": [ { "id": 42, "access_level": "READ_WRITE" } ], "groups": [ { "id": 10, "access_level": "READ_WRITE" } ] } } } } } }, "security": [ { "oauth2": [ "SANDBOX_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/sandboxes/{sandbox_id}/apps/{app_id}/logs": { "get": { "tags": [ "Sandbox API" ], "summary": "Get logs from a specific sandbox app", "operationId": "getSandboxAppLogsById", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "sandbox_id", "in": "path", "description": "The ID of the sandbox", "required": true, "schema": { "type": "string", "example": "sb-1234567890abcdef" } }, { "name": "app_id", "in": "path", "description": "The ID of the app", "required": true, "schema": { "type": "string", "example": "a1b2c3d" } }, { "name": "cursor", "in": "query", "description": "Cursor for pagination", "schema": { "type": "string", "example": "s=abc123def456;i=789" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxAppLogsView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/sandboxes/sb-12345/app-logs", "html_url": "https://app.buddy.works/my-project/sandboxes/sb-12345", "cursor": "s=42d52efd758847b6ae1320f5cc298412;i=10b4;b=a8912454a4244b0ebdb80091a60f6971;m=1a50487dbd4;t=63cee43ff68bc;x=71c225411b004bd8", "logs": [ "Started application.service.", "Application starting on port 3000...", "Database connection established successfully", "Loading configuration files...", "Initializing middleware components", "Setting up API routes", "Server ready to accept connections", "Health check endpoint available at /health", "Application successfully started in 2.3 seconds" ] } } } } }, "security": [ { "oauth2": [ "SANDBOX_INFO" ] } ] } }, "/workspaces/{workspace_domain}/sandboxes/{sandbox_id}/apps/{app_id}/start": { "post": { "tags": [ "Sandbox API" ], "summary": "Start a sandbox app", "operationId": "startSandboxApp", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "sandbox_id", "in": "path", "description": "The ID of the sandbox", "required": true, "schema": { "type": "string", "example": "sb-1234567890abcdef" } }, { "name": "app_id", "in": "path", "description": "The ID of the app", "required": true, "schema": { "type": "string", "example": "a1b2c3d" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxResponse" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-12345", "html_url": "https://app.buddy.works/sandboxes/sb-12345", "id": "sb-12345", "identifier": "my-api-sandbox", "name": "My API Development Sandbox", "status": "RUNNING", "source_sandbox_id": null, "snapshot_id": null, "os": "ubuntu:24.04", "resources": "2x4", "first_boot_commands": "npm install && npm run build", "app_dir": "/app", "apps": [ { "id": "a1b2c3d", "command": "npm start", "app_status": "RUNNING" } ], "timeout": 3600, "tags": [ "development", "api", "nodejs" ], "boot_logs": [ "Starting sandbox...", "Installing dependencies...", "npm install completed successfully", "Building application...", "Application ready on port 3000" ], "setup_status": "SUCCESS", "endpoints": [ { "name": "www", "endpoint": "80", "type": "HTTP", "region": "EU", "whitelist": [ "192.168.1.0/24" ], "timeout": 30, "http": { "endpoint_url": "https://www-my-api-sandbox-proj1757492386363-my-workspace.eu-1.buddy.app", "verify_certificate": true, "compression": true, "http2": true, "log_requests": true, "request_headers": { "X-Forwarded-For": "wp.pl" }, "response_headers": { "X-Frame-Options": "DENY" }, "circuit_breaker": 5, "serve_path": "/api" } } ], "project": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/proj1757492386363", "html_url": "https://app.buddy.works/proj1757492386363", "name": "proj1757492386363", "display_name": "proj1757492386363", "status": "ACTIVE" }, "variables": [ { "key": "my_var", "value": "some_value", "type": "VAR", "description": "a sandbox variable" } ], "permissions": { "others": "READ_ONLY", "users": [ { "id": 42, "access_level": "READ_WRITE" } ], "groups": [ { "id": 10, "access_level": "READ_WRITE" } ] } } } } } }, "security": [ { "oauth2": [ "SANDBOX_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/sandboxes/{sandbox_id}/apps/{app_id}/stop": { "post": { "tags": [ "Sandbox API" ], "summary": "Stop a sandbox app", "operationId": "stopSandboxApp", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "sandbox_id", "in": "path", "description": "The ID of the sandbox", "required": true, "schema": { "type": "string", "example": "sb-1234567890abcdef" } }, { "name": "app_id", "in": "path", "description": "The ID of the app", "required": true, "schema": { "type": "string", "example": "a1b2c3d" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxResponse" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-12345", "html_url": "https://app.buddy.works/sandboxes/sb-12345", "id": "sb-12345", "identifier": "my-api-sandbox", "name": "My API Development Sandbox", "status": "RUNNING", "source_sandbox_id": null, "snapshot_id": null, "os": "ubuntu:24.04", "resources": "2x4", "first_boot_commands": "npm install && npm run build", "app_dir": "/app", "apps": [ { "id": "a1b2c3d", "command": "npm start", "app_status": "RUNNING" } ], "timeout": 3600, "tags": [ "development", "api", "nodejs" ], "boot_logs": [ "Starting sandbox...", "Installing dependencies...", "npm install completed successfully", "Building application...", "Application ready on port 3000" ], "setup_status": "SUCCESS", "endpoints": [ { "name": "www", "endpoint": "80", "type": "HTTP", "region": "EU", "whitelist": [ "192.168.1.0/24" ], "timeout": 30, "http": { "endpoint_url": "https://www-my-api-sandbox-proj1757492386363-my-workspace.eu-1.buddy.app", "verify_certificate": true, "compression": true, "http2": true, "log_requests": true, "request_headers": { "X-Forwarded-For": "wp.pl" }, "response_headers": { "X-Frame-Options": "DENY" }, "circuit_breaker": 5, "serve_path": "/api" } } ], "project": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/proj1757492386363", "html_url": "https://app.buddy.works/proj1757492386363", "name": "proj1757492386363", "display_name": "proj1757492386363", "status": "ACTIVE" }, "variables": [ { "key": "my_var", "value": "some_value", "type": "VAR", "description": "a sandbox variable" } ], "permissions": { "others": "READ_ONLY", "users": [ { "id": 42, "access_level": "READ_WRITE" } ], "groups": [ { "id": 10, "access_level": "READ_WRITE" } ] } } } } } }, "security": [ { "oauth2": [ "SANDBOX_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/sandboxes/{sandbox_id}/commands": { "get": { "tags": [ "Sandbox API" ], "summary": "Get all commands executed in a sandbox", "operationId": "getSandboxCommands", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "sandbox_id", "in": "path", "description": "The ID of the sandbox", "required": true, "schema": { "type": "string", "example": "sb-1234567890abcdef" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxCommandsView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-12345/commands", "commands": [ { "url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-12345/commands/cmd-abc123def456", "id": "cmd-abc123def456", "command": "npm test", "runtime": "BASH", "status": "SUCCESSFUL", "exit_code": 0, "logs_url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-12345/commands/cmd-abc123def456/logs" }, { "url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-12345/commands/cmd-xyz789uvw012", "id": "cmd-xyz789uvw012", "command": "npm run build", "runtime": "BASH", "status": "SUCCESSFUL", "exit_code": 0, "logs_url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-12345/commands/cmd-xyz789uvw012/logs" } ] } } } } }, "security": [ { "oauth2": [ "SANDBOX_INFO" ] } ] }, "post": { "tags": [ "Sandbox API" ], "summary": "Execute a command in a sandbox", "operationId": "executeSandboxCommand", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "sandbox_id", "in": "path", "description": "The ID of the sandbox", "required": true, "schema": { "type": "string", "example": "sb-1234567890abcdef" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecuteSandboxCommandRequest" }, "example": { "command": "npm test", "runtime": "BASH" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxCommandView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-12345/commands/cmd-abc123def456", "html_url": null, "id": "cmd-abc123def456", "command": "npm test", "runtime": "BASH", "status": "SUCCESSFUL", "exit_code": 0, "logs_url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-12345/commands/cmd-abc123def456/logs" } } } } }, "security": [ { "oauth2": [ "SANDBOX_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/sandboxes/{sandbox_id}/commands/{id}": { "get": { "tags": [ "Sandbox API" ], "summary": "Get a specific command execution details", "operationId": "getSandboxCommand", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "sandbox_id", "in": "path", "description": "The ID of the sandbox", "required": true, "schema": { "type": "string", "example": "sb-1234567890abcdef" } }, { "name": "id", "in": "path", "description": "The ID of the command", "required": true, "schema": { "type": "string", "example": "cmd-9876543210fedcba" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxCommandView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-12345/commands/cmd-abc123def456", "html_url": null, "id": "cmd-abc123def456", "command": "npm test", "runtime": "BASH", "status": "SUCCESSFUL", "exit_code": 0, "logs_url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-12345/commands/cmd-abc123def456/logs" } } } } }, "security": [ { "oauth2": [ "SANDBOX_INFO" ] } ] } }, "/workspaces/{workspace_domain}/sandboxes/{sandbox_id}/commands/{command_id}/logs": { "get": { "tags": [ "Sandbox API" ], "summary": "Get logs from a specific command execution", "operationId": "getSandboxCommandLogs", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "sandbox_id", "in": "path", "description": "The ID of the sandbox", "required": true, "schema": { "type": "string", "example": "sb-1234567890abcdef" } }, { "name": "command_id", "in": "path", "description": "The ID of the command", "required": true, "schema": { "type": "string", "example": "cmd-9876543210fedcba" } }, { "name": "follow", "in": "query", "description": "If true, streams logs until the command completes", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/jsonl": { "schema": { "$ref": "#/components/schemas/SandboxCommandLog" }, "example": { "type": "STDOUT", "data": "total 24" } } } } }, "security": [ { "oauth2": [ "SANDBOX_INFO" ] } ] } }, "/workspaces/{workspace_domain}/sandboxes/{sandbox_id}/commands/{command_id}/terminate": { "post": { "tags": [ "Sandbox API" ], "summary": "Terminate a running command in a sandbox", "operationId": "terminateSandboxCommand", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "sandbox_id", "in": "path", "description": "The ID of the sandbox", "required": true, "schema": { "type": "string", "example": "sb-1234567890abcdef" } }, { "name": "command_id", "in": "path", "description": "The ID of the command", "required": true, "schema": { "type": "string", "example": "cmd-9876543210fedcba" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxCommandView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-12345/commands/cmd-abc123def456", "html_url": null, "id": "cmd-abc123def456", "command": "npm test", "runtime": "BASH", "status": "SUCCESSFUL", "exit_code": 0, "logs_url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-12345/commands/cmd-abc123def456/logs" } } } } }, "security": [ { "oauth2": [ "SANDBOX_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/sandboxes/{sandbox_id}/content/{path}": { "get": { "tags": [ "Sandbox API" ], "summary": "Get sandbox content by path", "description": "Get the contents of a directory or file metadata at the specified path in a sandbox. The sandbox must be running.", "operationId": "getSandboxContent", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "sandbox_id", "in": "path", "description": "The ID of the sandbox", "required": true, "schema": { "type": "string", "example": "sb-1234567890abcdef" } }, { "name": "path", "in": "path", "description": "Absolute path to the file or directory. Recommended directory is `/buddy`", "required": true, "schema": { "pattern": ".*", "type": "string", "example": "buddy/src" } } ], "responses": { "200": { "description": "Content retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxContentView" }, "examples": { "Directory listing": { "summary": "Get directory contents", "description": "Directory listing", "value": { "url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-12345/content/buddy/src", "html_url": "https://app.buddy.works/my-project/sandboxes/sb-12345", "contents": [ { "url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-12345/content/buddy/src/index.js", "html_url": "https://app.buddy.works/my-project/sandboxes/sb-12345", "type": "FILE", "name": "index.js", "path": "/buddy/src/index.js", "size": 1024 }, { "url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-12345/content/buddy/src/components", "html_url": "https://app.buddy.works/my-project/sandboxes/sb-12345", "type": "DIR", "name": "components", "path": "/buddy/src/components" } ] } }, "File metadata": { "summary": "Get file metadata", "description": "File metadata", "value": { "url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-12345/content/buddy/src/index.js", "html_url": "https://app.buddy.works/my-project/sandboxes/sb-12345", "contents": [ { "url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-12345/content/buddy/src/index.js", "html_url": "https://app.buddy.works/my-project/sandboxes/sb-12345", "type": "FILE", "name": "index.js", "path": "/buddy/src/index.js", "size": 1024 } ] } } } } } } }, "security": [ { "oauth2": [ "SANDBOX_READ" ] } ] }, "post": { "tags": [ "Sandbox API" ], "summary": "Create a directory in a sandbox", "description": "Create a directory at the specified path in a sandbox. The sandbox must be running.", "operationId": "createSandboxDirectory", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "sandbox_id", "in": "path", "description": "The ID of the sandbox", "required": true, "schema": { "type": "string", "example": "sb-1234567890abcdef" } }, { "name": "path", "in": "path", "description": "Absolute path where the directory should be created", "required": true, "schema": { "pattern": ".*", "type": "string", "example": "buddy/new-folder" } } ], "responses": { "201": { "description": "Directory created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxContentItem" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-12345/content/buddy/new-folder", "html_url": "https://app.buddy.works/my-project/sandboxes/sb-12345", "type": "DIR", "name": "new-folder", "path": "/buddy/new-folder" } } } }, "409": { "description": "Directory already exists", "content": { "application/json": { "example": { "errors": [ { "message": "Directory already exists" } ] } } } } }, "security": [ { "oauth2": [ "SANDBOX_MANAGE" ] } ] }, "delete": { "tags": [ "Sandbox API" ], "summary": "Delete a file or directory from a sandbox", "description": "Delete a file or directory at the specified path in a sandbox. The sandbox must be running.", "operationId": "deleteSandboxFile", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "sandbox_id", "in": "path", "description": "The ID of the sandbox", "required": true, "schema": { "type": "string", "example": "sb-1234567890abcdef" } }, { "name": "path", "in": "path", "description": "Absolute path to the file or directory to delete", "required": true, "schema": { "pattern": ".*", "type": "string", "example": "buddy/example.txt" } } ], "responses": { "204": { "description": "File or directory deleted successfully" } }, "security": [ { "oauth2": [ "SANDBOX_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/sandboxes/{sandbox_id}/content/upload/{path}": { "post": { "tags": [ "Sandbox API" ], "summary": "Upload a file to a sandbox", "description": "Upload a file to a specific path in a sandbox. The sandbox must be running.", "operationId": "uploadSandboxFile", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "sandbox_id", "in": "path", "description": "The ID of the sandbox", "required": true, "schema": { "type": "string", "example": "sb-1234567890abcdef" } }, { "name": "path", "in": "path", "description": "Absolute path where the file should be uploaded. Recommended directory is `/buddy`", "required": true, "schema": { "pattern": ".*", "type": "string", "example": "buddy/example.txt" } } ], "requestBody": { "description": "File to upload", "content": { "multipart/form-data": { "schema": { "type": "string", "format": "binary" } } } }, "responses": { "201": { "description": "File uploaded successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxContentItem" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-12345/content/buddy/src/index.js", "html_url": "https://app.buddy.works/my-project/sandboxes/sb-12345", "type": "FILE", "name": "index.js", "path": "/buddy/src/index.js", "size": 1024 } } } } }, "security": [ { "oauth2": [ "SANDBOX_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/sandboxes/{sandbox_id}/download/{path}": { "get": { "tags": [ "Sandbox API" ], "summary": "Download sandbox content as archive", "description": "Download a file or directory from a sandbox as a tar.gz archive. The sandbox must be running.", "operationId": "downloadSandboxContent", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "sandbox_id", "in": "path", "description": "The ID of the sandbox", "required": true, "schema": { "type": "string", "example": "sb-1234567890abcdef" } }, { "name": "path", "in": "path", "description": "Absolute path to the file or directory to download", "required": true, "schema": { "pattern": ".*", "type": "string", "example": "buddy/src" } } ], "responses": { "200": { "description": "Content downloaded successfully", "content": { "application/octet-stream": { "schema": { "type": "string", "description": "File download" } }, "application/gzip": { "schema": { "type": "string", "description": "Directory download as tar.gz archive" } } } } }, "security": [ { "oauth2": [ "SANDBOX_READ" ] } ] } }, "/workspaces/{workspace_domain}/sandboxes/{sandbox_id}/restart": { "post": { "tags": [ "Sandbox API" ], "summary": "Restart a sandbox", "operationId": "restartSandbox", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "sandbox_id", "in": "path", "description": "The ID of the sandbox", "required": true, "schema": { "type": "string", "example": "sb-1234567890abcdef" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxResponse" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-12345", "html_url": "https://app.buddy.works/sandboxes/sb-12345", "id": "sb-12345", "identifier": "my-api-sandbox", "name": "My API Development Sandbox", "status": "RUNNING", "source_sandbox_id": null, "snapshot_id": null, "os": "ubuntu:24.04", "resources": "2x4", "first_boot_commands": "npm install && npm run build", "app_dir": "/app", "apps": [ { "id": "a1b2c3d", "command": "npm start", "app_status": "RUNNING" } ], "timeout": 3600, "tags": [ "development", "api", "nodejs" ], "boot_logs": [ "Starting sandbox...", "Installing dependencies...", "npm install completed successfully", "Building application...", "Application ready on port 3000" ], "setup_status": "SUCCESS", "endpoints": [ { "name": "www", "endpoint": "80", "type": "HTTP", "region": "EU", "whitelist": [ "192.168.1.0/24" ], "timeout": 30, "http": { "endpoint_url": "https://www-my-api-sandbox-proj1757492386363-my-workspace.eu-1.buddy.app", "verify_certificate": true, "compression": true, "http2": true, "log_requests": true, "request_headers": { "X-Forwarded-For": "wp.pl" }, "response_headers": { "X-Frame-Options": "DENY" }, "circuit_breaker": 5, "serve_path": "/api" } } ], "project": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/proj1757492386363", "html_url": "https://app.buddy.works/proj1757492386363", "name": "proj1757492386363", "display_name": "proj1757492386363", "status": "ACTIVE" }, "variables": [ { "key": "my_var", "value": "some_value", "type": "VAR", "description": "a sandbox variable" } ], "permissions": { "others": "READ_ONLY", "users": [ { "id": 42, "access_level": "READ_WRITE" } ], "groups": [ { "id": 10, "access_level": "READ_WRITE" } ] } } } } } }, "security": [ { "oauth2": [ "SANDBOX_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/sandboxes/{sandbox_id}/snapshots": { "get": { "tags": [ "Sandbox API" ], "summary": "Get all snapshots for a sandbox", "operationId": "getSandboxSnapshots", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "sandbox_id", "in": "path", "description": "The ID of the sandbox", "required": true, "schema": { "type": "string", "example": "sb-1234567890abcdef" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotsView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-12345/snapshots", "html_url": "https://app.buddy.works/my-project/sandboxes/sb-12345/snapshots", "snapshots": [ { "url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-12345/snapshots/sn-abc123def456", "html_url": "https://app.buddy.works/my-project/sandboxes/sb-12345/snapshots", "id": "sn-abc123def456", "name": "My API Sandbox-20250822T10:30:15", "size": 2, "status": "CREATED", "create_date": "2025-08-22T10:30:18.123456789Z" }, { "url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-12345/snapshots/sn-xyz789uvw012", "html_url": "https://app.buddy.works/my-project/sandboxes/sb-12345/snapshots", "id": "sn-xyz789uvw012", "name": "Production backup-20250821T15:45:33", "size": 4, "status": "CREATED", "create_date": "2025-08-21T15:45:36.987654321Z" }, { "url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-12345/snapshots/sn-mno345pqr678", "html_url": "https://app.buddy.works/my-project/sandboxes/sb-12345/snapshots", "id": "sn-mno345pqr678", "name": "Feature branch-20250820T09:15:42", "size": 1, "status": "CREATED", "create_date": "2025-08-20T09:15:45.456789012Z" } ] } } } } }, "security": [ { "oauth2": [ "SANDBOX_MANAGE" ] } ] }, "post": { "tags": [ "Sandbox API" ], "summary": "Create a new snapshot of a sandbox", "operationId": "addSandboxSnapshot", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "sandbox_id", "in": "path", "description": "The ID of the sandbox", "required": true, "schema": { "type": "string", "example": "sb-1234567890abcdef" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddSnapshotRequest" }, "example": { "name": "Manual backup before deployment" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-12345/snapshots/sn-abc123def456", "html_url": "https://app.buddy.works/my-project/sandboxes/sb-12345/snapshots", "id": "sn-abc123def456", "name": "My API Sandbox-20250822T10:30:15", "size": 2, "status": "CREATED", "create_date": "2025-08-22T10:30:18.123456789Z", "created_by": { "url": "https://api.buddy.works/workspaces/my-workspace/members/42", "html_url": "https://app.buddy.works/profile/42", "id": 42, "name": "john.doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/42/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6/w/32/32/AVATAR.png?ts=1724320218123", "email": "john.doe@company.com", "admin": false, "workspace_owner": false } } } } } }, "security": [ { "oauth2": [ "SANDBOX_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/sandboxes/{sandbox_id}/snapshots/{id}": { "get": { "tags": [ "Sandbox API" ], "summary": "Get a specific snapshot by ID", "operationId": "getSandboxSnapshot", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "sandbox_id", "in": "path", "description": "The ID of the sandbox", "required": true, "schema": { "type": "string", "example": "sb-1234567890abcdef" } }, { "name": "id", "in": "path", "description": "The ID of the snapshot", "required": true, "schema": { "type": "string", "example": "snap-abcdef1234567890" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-12345/snapshots/sn-abc123def456", "html_url": "https://app.buddy.works/my-project/sandboxes/sb-12345/snapshots", "id": "sn-abc123def456", "name": "My API Sandbox-20250822T10:30:15", "size": 2, "status": "CREATED", "create_date": "2025-08-22T10:30:18.123456789Z", "created_by": { "url": "https://api.buddy.works/workspaces/my-workspace/members/42", "html_url": "https://app.buddy.works/profile/42", "id": 42, "name": "john.doe", "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/42/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6/w/32/32/AVATAR.png?ts=1724320218123", "email": "john.doe@company.com", "admin": false, "workspace_owner": false } } } } } }, "security": [ { "oauth2": [ "SANDBOX_MANAGE" ] } ] }, "delete": { "tags": [ "Sandbox API" ], "summary": "Delete a sandbox snapshot", "operationId": "deleteSandboxSnapshot", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "sandbox_id", "in": "path", "description": "The ID of the sandbox", "required": true, "schema": { "type": "string", "example": "sb-1234567890abcdef" } }, { "name": "id", "in": "path", "description": "The ID of the snapshot", "required": true, "schema": { "type": "string", "example": "snap-abcdef1234567890" } } ], "responses": { "204": { "description": "Sandbox snapshot deleted successfully" } }, "security": [ { "oauth2": [ "SANDBOX_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/sandboxes/{sandbox_id}/start": { "post": { "tags": [ "Sandbox API" ], "summary": "Start a sandbox", "operationId": "startSandbox", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "sandbox_id", "in": "path", "description": "The ID of the sandbox", "required": true, "schema": { "type": "string", "example": "sb-1234567890abcdef" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxResponse" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-12345", "html_url": "https://app.buddy.works/sandboxes/sb-12345", "id": "sb-12345", "identifier": "my-api-sandbox", "name": "My API Development Sandbox", "status": "RUNNING", "source_sandbox_id": null, "snapshot_id": null, "os": "ubuntu:24.04", "resources": "2x4", "first_boot_commands": "npm install && npm run build", "app_dir": "/app", "apps": [ { "id": "a1b2c3d", "command": "npm start", "app_status": "RUNNING" } ], "timeout": 3600, "tags": [ "development", "api", "nodejs" ], "boot_logs": [ "Starting sandbox...", "Installing dependencies...", "npm install completed successfully", "Building application...", "Application ready on port 3000" ], "setup_status": "SUCCESS", "endpoints": [ { "name": "www", "endpoint": "80", "type": "HTTP", "region": "EU", "whitelist": [ "192.168.1.0/24" ], "timeout": 30, "http": { "endpoint_url": "https://www-my-api-sandbox-proj1757492386363-my-workspace.eu-1.buddy.app", "verify_certificate": true, "compression": true, "http2": true, "log_requests": true, "request_headers": { "X-Forwarded-For": "wp.pl" }, "response_headers": { "X-Frame-Options": "DENY" }, "circuit_breaker": 5, "serve_path": "/api" } } ], "project": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/proj1757492386363", "html_url": "https://app.buddy.works/proj1757492386363", "name": "proj1757492386363", "display_name": "proj1757492386363", "status": "ACTIVE" }, "variables": [ { "key": "my_var", "value": "some_value", "type": "VAR", "description": "a sandbox variable" } ], "permissions": { "others": "READ_ONLY", "users": [ { "id": 42, "access_level": "READ_WRITE" } ], "groups": [ { "id": 10, "access_level": "READ_WRITE" } ] } } } } } }, "security": [ { "oauth2": [ "SANDBOX_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/sandboxes/{sandbox_id}/stop": { "post": { "tags": [ "Sandbox API" ], "summary": "Stop a sandbox", "operationId": "stopSandbox", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "sandbox_id", "in": "path", "description": "The ID of the sandbox", "required": true, "schema": { "type": "string", "example": "sb-1234567890abcdef" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxResponse" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-12345", "html_url": "https://app.buddy.works/sandboxes/sb-12345", "id": "sb-12345", "identifier": "my-api-sandbox", "name": "My API Development Sandbox", "status": "RUNNING", "source_sandbox_id": null, "snapshot_id": null, "os": "ubuntu:24.04", "resources": "2x4", "first_boot_commands": "npm install && npm run build", "app_dir": "/app", "apps": [ { "id": "a1b2c3d", "command": "npm start", "app_status": "RUNNING" } ], "timeout": 3600, "tags": [ "development", "api", "nodejs" ], "boot_logs": [ "Starting sandbox...", "Installing dependencies...", "npm install completed successfully", "Building application...", "Application ready on port 3000" ], "setup_status": "SUCCESS", "endpoints": [ { "name": "www", "endpoint": "80", "type": "HTTP", "region": "EU", "whitelist": [ "192.168.1.0/24" ], "timeout": 30, "http": { "endpoint_url": "https://www-my-api-sandbox-proj1757492386363-my-workspace.eu-1.buddy.app", "verify_certificate": true, "compression": true, "http2": true, "log_requests": true, "request_headers": { "X-Forwarded-For": "wp.pl" }, "response_headers": { "X-Frame-Options": "DENY" }, "circuit_breaker": 5, "serve_path": "/api" } } ], "project": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/proj1757492386363", "html_url": "https://app.buddy.works/proj1757492386363", "name": "proj1757492386363", "display_name": "proj1757492386363", "status": "ACTIVE" }, "variables": [ { "key": "my_var", "value": "some_value", "type": "VAR", "description": "a sandbox variable" } ], "permissions": { "others": "READ_ONLY", "users": [ { "id": 42, "access_level": "READ_WRITE" } ], "groups": [ { "id": 10, "access_level": "READ_WRITE" } ] } } } } } }, "security": [ { "oauth2": [ "SANDBOX_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/sandboxes/{sandbox_id}/yaml": { "get": { "tags": [ "Sandbox API" ], "summary": "Get sandbox configuration as YAML", "operationId": "getSandboxYaml", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "sandbox_id", "in": "path", "description": "The ID of the sandbox", "required": true, "schema": { "type": "string", "example": "sb-1234567890abcdef" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxYamlView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/sandboxes/sb-12345", "html_url": "https://app.buddy.works/my-project/sandboxes/sb-12345", "yaml": "LSBzYW5kYm94OiBteS1hcGktc2FuZGJveAogIG5hbWU6IE15IEFQSSBEZXZlbG9wbWVudCBTYW5kYm94CiAgb3M6IHVidW50dToyNC4wNAogIHJlc291cmNlczogMng0CiAgaW5zdGFsbF9jb21tYW5kczogbnBtIGluc3RhbGwgJiYgbnBtIHJ1biBidWlsZAogIGFwcHM6CiAgLSBucG0gc3RhcnQKICBhcHBfZGlyOiAvYXBwCiAgZW5kcG9pbnRzOgogIC0gbmFtZTogd3d3CiAgICBlbmRwb2ludDogODAKICAgIHR5cGU6IEhUVFAKICAgIHJlZ2lvbjogRVUKICAgIHRpbWVvdXQ6IDMwCiAgICBodHRwOgogICAgICB2ZXJpZnlfY2VydGlmaWNhdGU6IHRydWUKICAgICAgY29tcHJlc3Npb246IHRydWUKICAgICAgaHR0cDI6IHRydWUKICAgICAgbG9nX3JlcXVlc3RzOiB0cnVlCiAgICAgIGNpcmN1aXRfYnJlYWtlcjogNQogICAgICBzZXJ2ZV9wYXRoOiAvYXBpCg==" } } } } }, "security": [ { "oauth2": [ "SANDBOX_INFO" ] } ] }, "patch": { "tags": [ "Sandbox API" ], "summary": "Update sandbox configuration using YAML", "operationId": "updateSandboxByYaml", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "sandbox_id", "in": "path", "description": "The ID of the sandbox", "required": true, "schema": { "type": "string", "example": "sb-1234567890abcdef" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxYamlView" }, "example": { "yaml": "LSBzYW5kYm94OiBteS1hcGktc2FuZGJveAogIG5hbWU6IE15IEFQSSBEZXZlbG9wbWVudCBTYW5kYm94CiAgb3M6IHVidW50dToyNC4wNAogIHJlc291cmNlczogMng0CiAgaW5zdGFsbF9jb21tYW5kczogbnBtIGluc3RhbGwgJiYgbnBtIHJ1biBidWlsZAogIGFwcHM6CiAgLSBucG0gc3RhcnQKICBhcHBfZGlyOiAvYXBwCiAgZW5kcG9pbnRzOgogIC0gbmFtZTogd3d3CiAgICBlbmRwb2ludDogODAKICAgIHR5cGU6IEhUVFAKICAgIHJlZ2lvbjogRVUKICAgIHRpbWVvdXQ6IDMwCiAgICBodHRwOgogICAgICB2ZXJpZnlfY2VydGlmaWNhdGU6IHRydWUKICAgICAgY29tcHJlc3Npb246IHRydWUKICAgICAgaHR0cDI6IHRydWUKICAgICAgbG9nX3JlcXVlc3RzOiB0cnVlCiAgICAgIGNpcmN1aXRfYnJlYWtlcjogNQogICAgICBzZXJ2ZV9wYXRoOiAvYXBpCg==" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxResponse" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-12345", "html_url": "https://app.buddy.works/sandboxes/sb-12345", "id": "sb-12345", "identifier": "my-api-sandbox", "name": "My API Development Sandbox", "status": "RUNNING", "source_sandbox_id": null, "snapshot_id": null, "os": "ubuntu:24.04", "resources": "2x4", "first_boot_commands": "npm install && npm run build", "app_dir": "/app", "apps": [ { "id": "a1b2c3d", "command": "npm start", "app_status": "RUNNING" } ], "timeout": 3600, "tags": [ "development", "api", "nodejs" ], "boot_logs": [ "Starting sandbox...", "Installing dependencies...", "npm install completed successfully", "Building application...", "Application ready on port 3000" ], "setup_status": "SUCCESS", "endpoints": [ { "name": "www", "endpoint": "80", "type": "HTTP", "region": "EU", "whitelist": [ "192.168.1.0/24" ], "timeout": 30, "http": { "endpoint_url": "https://www-my-api-sandbox-proj1757492386363-my-workspace.eu-1.buddy.app", "verify_certificate": true, "compression": true, "http2": true, "log_requests": true, "request_headers": { "X-Forwarded-For": "wp.pl" }, "response_headers": { "X-Frame-Options": "DENY" }, "circuit_breaker": 5, "serve_path": "/api" } } ], "project": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/proj1757492386363", "html_url": "https://app.buddy.works/proj1757492386363", "name": "proj1757492386363", "display_name": "proj1757492386363", "status": "ACTIVE" }, "variables": [ { "key": "my_var", "value": "some_value", "type": "VAR", "description": "a sandbox variable" } ], "permissions": { "others": "READ_ONLY", "users": [ { "id": 42, "access_level": "READ_WRITE" } ], "groups": [ { "id": 10, "access_level": "READ_WRITE" } ] } } } } } }, "security": [ { "oauth2": [ "SANDBOX_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/sandboxes/snapshots": { "get": { "tags": [ "Sandbox API" ], "summary": "Get all snapshots for a project", "operationId": "getProjectSnapshots", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "query", "description": "The human-readable ID of the project to filter sandboxes", "required": true, "schema": { "type": "string", "example": "my-project" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotsView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-12345/snapshots", "html_url": "https://app.buddy.works/my-project/sandboxes/sb-12345/snapshots", "snapshots": [ { "url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-12345/snapshots/sn-abc123def456", "html_url": "https://app.buddy.works/my-project/sandboxes/sb-12345/snapshots", "id": "sn-abc123def456", "name": "My API Sandbox-20250822T10:30:15", "size": 2, "status": "CREATED", "create_date": "2025-08-22T10:30:18.123456789Z" }, { "url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-12345/snapshots/sn-xyz789uvw012", "html_url": "https://app.buddy.works/my-project/sandboxes/sb-12345/snapshots", "id": "sn-xyz789uvw012", "name": "Production backup-20250821T15:45:33", "size": 4, "status": "CREATED", "create_date": "2025-08-21T15:45:36.987654321Z" }, { "url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-12345/snapshots/sn-mno345pqr678", "html_url": "https://app.buddy.works/my-project/sandboxes/sb-12345/snapshots", "id": "sn-mno345pqr678", "name": "Feature branch-20250820T09:15:42", "size": 1, "status": "CREATED", "create_date": "2025-08-20T09:15:45.456789012Z" } ] } } } } }, "security": [ { "oauth2": [ "SANDBOX_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/sandboxes/snapshots/{id}": { "delete": { "tags": [ "Sandbox API" ], "summary": "Delete a snapshot by ID", "operationId": "deleteSnapshot", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "id", "in": "path", "description": "The ID of the snapshot", "required": true, "schema": { "type": "string", "example": "snap-abcdef1234567890" } } ], "responses": { "204": { "description": "Sandbox snapshot deleted successfully" } }, "security": [ { "oauth2": [ "SANDBOX_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/sandboxes/yaml": { "post": { "tags": [ "Sandbox API" ], "summary": "Create a new sandbox from YAML configuration", "operationId": "addSandboxByYaml", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "query", "description": "The human-readable ID of the project to filter sandboxes", "required": true, "schema": { "type": "string", "example": "my-project" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxYamlView" }, "example": { "yaml": "LSBzYW5kYm94OiBteS1hcGktc2FuZGJveAogIG5hbWU6IE15IEFQSSBEZXZlbG9wbWVudCBTYW5kYm94CiAgb3M6IHVidW50dToyNC4wNAogIHJlc291cmNlczogMng0CiAgaW5zdGFsbF9jb21tYW5kczogbnBtIGluc3RhbGwgJiYgbnBtIHJ1biBidWlsZAogIGFwcHM6CiAgLSBucG0gc3RhcnQKICBhcHBfZGlyOiAvYXBwCiAgZW5kcG9pbnRzOgogIC0gbmFtZTogd3d3CiAgICBlbmRwb2ludDogODAKICAgIHR5cGU6IEhUVFAKICAgIHJlZ2lvbjogRVUKICAgIHRpbWVvdXQ6IDMwCiAgICBodHRwOgogICAgICB2ZXJpZnlfY2VydGlmaWNhdGU6IHRydWUKICAgICAgY29tcHJlc3Npb246IHRydWUKICAgICAgaHR0cDI6IHRydWUKICAgICAgbG9nX3JlcXVlc3RzOiB0cnVlCiAgICAgIGNpcmN1aXRfYnJlYWtlcjogNQogICAgICBzZXJ2ZV9wYXRoOiAvYXBpCg==" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxResponse" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-12345", "html_url": "https://app.buddy.works/sandboxes/sb-12345", "id": "sb-12345", "identifier": "my-api-sandbox", "name": "My API Development Sandbox", "status": "RUNNING", "source_sandbox_id": null, "snapshot_id": null, "os": "ubuntu:24.04", "resources": "2x4", "first_boot_commands": "npm install && npm run build", "app_dir": "/app", "apps": [ { "id": "a1b2c3d", "command": "npm start", "app_status": "RUNNING" } ], "timeout": 3600, "tags": [ "development", "api", "nodejs" ], "boot_logs": [ "Starting sandbox...", "Installing dependencies...", "npm install completed successfully", "Building application...", "Application ready on port 3000" ], "setup_status": "SUCCESS", "endpoints": [ { "name": "www", "endpoint": "80", "type": "HTTP", "region": "EU", "whitelist": [ "192.168.1.0/24" ], "timeout": 30, "http": { "endpoint_url": "https://www-my-api-sandbox-proj1757492386363-my-workspace.eu-1.buddy.app", "verify_certificate": true, "compression": true, "http2": true, "log_requests": true, "request_headers": { "X-Forwarded-For": "wp.pl" }, "response_headers": { "X-Frame-Options": "DENY" }, "circuit_breaker": 5, "serve_path": "/api" } } ], "project": { "url": "https://api.buddy.works/workspaces/my-workspace/projects/proj1757492386363", "html_url": "https://app.buddy.works/proj1757492386363", "name": "proj1757492386363", "display_name": "proj1757492386363", "status": "ACTIVE" }, "variables": [ { "key": "my_var", "value": "some_value", "type": "VAR", "description": "a sandbox variable" } ], "permissions": { "others": "READ_ONLY", "users": [ { "id": 42, "access_level": "READ_WRITE" } ], "groups": [ { "id": 10, "access_level": "READ_WRITE" } ] } } } } } }, "security": [ { "oauth2": [ "SANDBOX_INFO" ] } ] } }, "/workspaces/{workspace_domain}/sso": { "get": { "tags": [ "Workspace API" ], "summary": "Get SSO configuration", "operationId": "getSSO", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SSOView" }, "example": { "url": "https://api.buddy.works/workspaces/my-company/sso", "html_url": "https://app.buddy.works/my-company/-/workspace/sso", "type": "SAML", "sso_provider_type": "CUSTOM", "sso_url": "https://sso.example.com/saml", "issuer": "https://sso.example.com", "certificate": "-----BEGIN CERTIFICATE-----\nMIIC...certificate content...\n-----END CERTIFICATE-----", "signature_method": "sha256", "digest_method": "sha256", "require_sso_for_all_members": true } } } } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] }, "patch": { "tags": [ "Workspace API" ], "summary": "Update SSO configuration", "operationId": "updateSSO", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSSORequest" }, "example": { "type": "SAML", "sso_url": "https://sso.example.com/saml", "issuer": "https://sso.example.com", "certificate": "-----BEGIN CERTIFICATE-----\nMIIC...certificate content...\n-----END CERTIFICATE-----", "signature_method": "sha256", "digest_method": "sha256", "require_sso_for_all_members": true } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SSOView" }, "example": { "url": "https://api.buddy.works/workspaces/my-company/sso", "html_url": "https://app.buddy.works/my-company/-/workspace/sso", "type": "SAML", "sso_provider_type": "CUSTOM", "sso_url": "https://sso.example.com/saml", "issuer": "https://sso.example.com", "certificate": "-----BEGIN CERTIFICATE-----\nMIIC...certificate content...\n-----END CERTIFICATE-----", "signature_method": "sha256", "digest_method": "sha256", "require_sso_for_all_members": true } } } } }, "security": [ { "oauth2": [ "WORKSPACE" ] } ] } }, "/workspaces/{workspace_domain}/targets": { "get": { "tags": [ "Target API" ], "summary": "Get all deployment targets in the workspace", "operationId": "getTargets", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "query", "description": "Filter targets by project name", "schema": { "type": "string", "example": "my-project" } }, { "name": "pipeline_id", "in": "query", "description": "Filter targets by pipeline ID", "schema": { "type": "integer", "format": "int64", "example": 12345 } }, { "name": "environment_id", "in": "query", "description": "Filter targets by environment ID", "schema": { "type": "string", "example": "67890" } }, { "name": "action_id", "in": "query", "description": "Filter targets by action ID", "schema": { "type": "integer", "format": "int64", "example": 98765 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TargetsView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/targets", "html_url": "https://app.buddy.works/targets", "targets": [ { "url": "https://api.buddy.works/workspaces/my-workspace/targets/tg-12345", "html_url": "https://app.buddy.works/targets/tg-12345", "id": "tg-12345", "identifier": "production-web-server", "name": "Production Web Server", "type": "SSH" }, { "url": "https://api.buddy.works/workspaces/my-workspace/targets/tg-67890", "html_url": "https://app.buddy.works/targets/tg-67890", "id": "tg-67890", "identifier": "gke-production", "name": "GKE Production Cluster", "type": "GKE" }, { "url": "https://api.buddy.works/workspaces/my-workspace/targets/tg-54321", "html_url": "https://app.buddy.works/targets/tg-54321", "id": "tg-54321", "identifier": "ftp-server", "name": "FTP File Server", "type": "FTP" } ] } } } } }, "security": [ { "oauth2": [ "TARGET_INFO" ] } ] }, "post": { "tags": [ "Target API" ], "summary": "Create a new deployment target", "operationId": "addTarget", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TargetView" }, "examples": { "SSH Target (SSH_KEY)": { "description": "SSH Target (SSH_KEY)", "value": { "type": "SSH", "identifier": "production-web-server", "name": "Production Web Server", "host": "web.example.com", "port": "22", "path": "/var/www/html", "auth": { "method": "SSH_KEY", "username": "deploy", "key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEA...\n-----END RSA PRIVATE KEY-----", "passphrase": "keypassphrase" }, "tags": [ "production", "web", "deploy" ], "pipelinesAccessLevel": "DENIED", "allowedPipelines": [ { "project": "my-project", "pipeline": "deploy-pipeline" }, { "project": "my-project", "pipeline": "hotfix-pipeline" } ] } }, "SSH Target (PASSWORD)": { "description": "SSH Target (PASSWORD)", "value": { "type": "SSH", "identifier": "ssh-pipeline", "name": "SSH Pipeline", "host": "my-server.tests", "port": "1234", "path": "target/path/on/server", "auth": { "method": "PASSWORD", "username": "my-user", "password": "my-password" }, "tags": [ "ssh", "pipeline" ] } }, "SSH Target (SSH_KEY without passphrase)": { "description": "SSH Target (SSH_KEY without passphrase)", "value": { "type": "SSH", "identifier": "ssh-key-target", "name": "SSH Key Target", "host": "5.75.234.250", "port": "22", "auth": { "method": "SSH_KEY", "username": "sftp-key-0", "key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEA...\n-----END RSA PRIVATE KEY-----" }, "tags": [ "ssh", "key" ] } }, "SSH Target (SSH_KEY with passphrase)": { "description": "SSH Target (SSH_KEY with passphrase)", "value": { "type": "SSH", "identifier": "ssh-key-passphrase-target", "name": "SSH Key with Passphrase Target", "host": "5.75.234.250", "port": "22", "auth": { "method": "SSH_KEY", "username": "sftp-pass-key-phrase-0", "key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEA...\n-----END RSA PRIVATE KEY-----", "passphrase": "key-passphrase" }, "tags": [ "ssh", "key", "passphrase" ] } }, "FTP Target": { "description": "FTP Target", "value": { "type": "FTP", "identifier": "ftp-server", "name": "FTP File Server", "host": "ftp.example.com", "port": "21", "path": "/public_html", "auth": { "username": "ftpuser", "password": "ftppass123" }, "secure": false, "tags": [ "ftp", "files" ] } }, "FTPS Target (Secure FTP)": { "description": "FTPS Target (Secure FTP)", "value": { "type": "FTP", "identifier": "ftps-secure-server", "name": "FTPS Secure File Server", "host": "ftps.example.com", "port": "21", "path": "/var/www/secure", "auth": { "username": "ftpsuser", "password": "ftpspass123" }, "secure": true, "tags": [ "ftps", "secure", "files" ] } }, "Google Kubernetes Engine Target": { "description": "Google Kubernetes Engine Target", "value": { "type": "GKE", "identifier": "gke-production", "name": "GKE Production Cluster", "integration": "google-cloud-integration", "cluster": "production-cluster", "region": "us-central1", "project_id": "my-gcp-project", "zone": "us-central1-a", "tags": [ "kubernetes", "gcp", "production" ] } }, "Amazon Elastic Kubernetes Service Target": { "description": "Amazon Elastic Kubernetes Service Target", "value": { "type": "EKS", "identifier": "eks-staging", "name": "EKS Staging Cluster", "integration": "aws-integration", "cluster": "staging-cluster", "region": "us-west-2", "role_arn": "arn:aws:iam::123456789012:role/eks-service-role", "tags": [ "kubernetes", "aws", "staging" ] } }, "Azure Kubernetes Service Target": { "description": "Azure Kubernetes Service Target", "value": { "type": "AKS", "identifier": "aks-development", "name": "AKS Development Cluster", "integration": "azure-integration", "cluster": "dev-cluster", "region": "eastus", "subscription": "12345678-1234-1234-1234-123456789012", "resource_group": "dev-resource-group", "tags": [ "kubernetes", "azure", "development" ] } }, "DigitalOcean Kubernetes Target": { "description": "DigitalOcean Kubernetes Target", "value": { "type": "DOKS", "identifier": "do-k8s-cluster", "name": "DigitalOcean Kubernetes Cluster", "integration": "digitalocean-integration", "cluster": "do-cluster-prod", "region": "nyc1", "tags": [ "kubernetes", "digitalocean", "production" ] } }, "Amazon EC2 Target": { "description": "Amazon EC2 Target", "value": { "type": "EC2", "identifier": "ec2-web-instances", "name": "EC2 Web Server Instances", "integration": "aws-integration", "region": "us-east-1", "tags": [ "aws", "ec2", "web" ] } }, "DigitalOcean Target": { "description": "DigitalOcean Target", "value": { "type": "DIGITAL_OCEAN", "identifier": "do-droplets", "name": "DigitalOcean Droplets", "integration": "digitalocean-integration", "region": "nyc3", "tags": [ "digitalocean", "droplets" ] } }, "Vultr Target": { "description": "Vultr Target", "value": { "type": "VULTR", "identifier": "vultr-instances", "name": "Vultr Server Instances", "integration": "vultr-integration", "region": "ewr", "tags": [ "vultr", "servers" ] } }, "UpCloud Target": { "description": "UpCloud Target", "value": { "type": "UPCLOUD", "identifier": "upcloud-servers", "name": "UpCloud Servers", "integration": "upcloud-integration", "region": "fi-hel1", "tags": [ "upcloud", "servers" ] } }, "Git Target": { "description": "Git Target", "value": { "type": "GIT", "identifier": "git-repo-target", "name": "Git Repository Target", "repository": "https://github.com/company/project.git", "auth": { "method": "HTTP", "username": "git-user", "password": "ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" }, "tags": [ "git", "repository" ] } }, "Kubernetes Cluster Target": { "description": "Kubernetes Cluster Target", "value": { "type": "K8S_CLUSTER", "identifier": "k8s-production-cluster", "name": "Production Kubernetes Cluster", "cluster": "https://k8s-api.example.com:6443", "auth": { "method": "TOKEN", "token": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjEyMzQ1NiJ9..." }, "tags": [ "kubernetes", "production", "cluster" ] } }, "MySQL Target": { "description": "MySQL Target", "value": { "type": "MYSQL", "identifier": "production-db", "name": "Production MySQL", "host": "db.example.com", "port": 3306, "database": "myapp", "auth": { "method": "PASSWORD", "username": "deploy_user", "password": "secured" }, "tags": [ "mysql", "production" ] } }, "PostgreSQL Target": { "description": "PostgreSQL Target", "value": { "type": "POSTGRESQL", "identifier": "production-pg", "name": "Production PostgreSQL", "host": "pg.example.com", "port": 5432, "database": "myapp", "auth": { "method": "PASSWORD", "username": "deploy_user", "password": "secured" }, "tags": [ "postgresql", "production" ] } }, "MongoDB Target": { "description": "MongoDB Target", "value": { "type": "MONGO", "identifier": "production-mongo", "name": "Production MongoDB", "host": "mongo.example.com", "port": "27017", "database": "myapp", "auth_source": "admin", "auth": { "method": "PASSWORD", "username": "deploy_user", "password": "secured" }, "proxy": { "name": "ssh-bastion" }, "tags": [ "mongodb" ] } }, "MSSQL Target": { "description": "MSSQL Target", "value": { "type": "MSSQL", "identifier": "production-mssql", "name": "Production MSSQL", "host": "mssql.example.com", "port": "1433", "database": "app", "auth": { "method": "PASSWORD", "username": "app_user", "password": "secured" }, "tags": [ "mssql", "production" ] } }, "RDS MSSQL Target": { "description": "RDS MSSQL Target", "value": { "type": "RDS_MSSQL", "identifier": "rds-mssql-prod", "name": "Production MSSQL on RDS", "integration": "aws-prod", "region": "us-east-1", "db_instance_identifier": "my-prod-mssql", "host": "my-prod-mssql.abc123.us-east-1.rds.amazonaws.com", "port": "1433", "database": "production", "ssl_mode": "REQUIRE", "auth": { "method": "PASSWORD", "username": "admin", "password": "secured" }, "tags": [ "rds", "mssql", "production" ] } } } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TargetView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/targets/tg-12345", "html_url": "https://app.buddy.works/targets/tg-12345", "id": "tg-12345", "identifier": "production-web-server", "name": "Production Web Server", "type": "SSH", "host": "web.example.com", "port": "22", "path": "/var/www/html", "auth": { "method": "SSH_KEY", "username": "deploy", "asset": "production-ssh-key" }, "tags": [ "production", "web", "deploy" ], "pipelinesAccessLevel": "DENIED", "allowedPipelines": [ { "project": "my-project", "pipeline": "deploy-pipeline" }, { "project": "my-project", "pipeline": "hotfix-pipeline" } ], "permissions": { "others": "READ_ONLY", "users": [ { "id": 42, "access_level": "USE_ONLY" } ], "groups": [] } } } } } }, "security": [ { "oauth2": [ "TARGET_ADD" ] } ] } }, "/workspaces/{workspace_domain}/targets/{id}": { "get": { "tags": [ "Target API" ], "summary": "Get a specific target by ID", "operationId": "getTarget", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "id", "in": "path", "description": "Target unique identifier (hash ID)", "required": true, "schema": { "type": "string", "example": "tgt-1234567890abcdef" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TargetView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/targets/tg-12345", "html_url": "https://app.buddy.works/targets/tg-12345", "id": "tg-12345", "identifier": "production-web-server", "name": "Production Web Server", "type": "SSH", "host": "web.example.com", "port": "22", "path": "/var/www/html", "auth": { "method": "SSH_KEY", "username": "deploy", "asset": "production-ssh-key" }, "tags": [ "production", "web", "deploy" ], "pipelinesAccessLevel": "DENIED", "allowedPipelines": [ { "project": "my-project", "pipeline": "deploy-pipeline" }, { "project": "my-project", "pipeline": "hotfix-pipeline" } ], "permissions": { "others": "READ_ONLY", "users": [ { "id": 42, "access_level": "USE_ONLY" } ], "groups": [] } } } } } }, "security": [ { "oauth2": [ "TARGET_INFO" ] } ] }, "delete": { "tags": [ "Target API" ], "summary": "Delete a deployment target", "operationId": "deleteTarget", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "id", "in": "path", "description": "Target unique identifier (hash ID)", "required": true, "schema": { "type": "string", "example": "tgt-1234567890abcdef" } } ], "responses": { "204": { "description": "Target deleted successfully" }, "404": { "description": "Target not found" } }, "security": [ { "oauth2": [ "TARGET_MANAGE" ] } ] }, "patch": { "tags": [ "Target API" ], "summary": "Update target configuration", "operationId": "updateTarget", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "id", "in": "path", "description": "Target unique identifier (hash ID)", "required": true, "schema": { "type": "string", "example": "tgt-1234567890abcdef" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TargetView" }, "examples": { "Update target configuration": { "description": "Update target configuration", "value": { "type": "SSH", "name": "Updated Production Web Server", "host": "web-new.example.com", "port": "2222", "path": "/var/www/app", "auth": { "method": "SSH_KEY", "username": "deploy", "asset": "production-ssh-key", "passphrase": "newpassphrase" }, "tags": [ "production", "web", "deploy", "updated" ] } }, "Update target name only": { "description": "Update target name only", "value": { "name": "Renamed Production Server", "type": "SSH" } }, "SSH Target (SSH_KEY)": { "description": "SSH Target (SSH_KEY)", "value": { "type": "SSH", "identifier": "production-web-server", "name": "Production Web Server", "host": "web.example.com", "port": "22", "path": "/var/www/html", "auth": { "method": "SSH_KEY", "username": "deploy", "key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEA...\n-----END RSA PRIVATE KEY-----", "passphrase": "keypassphrase" }, "tags": [ "production", "web", "deploy" ], "pipelinesAccessLevel": "DENIED", "allowedPipelines": [ { "project": "my-project", "pipeline": "deploy-pipeline" }, { "project": "my-project", "pipeline": "hotfix-pipeline" } ] } }, "SSH Target (PASSWORD)": { "description": "SSH Target (PASSWORD)", "value": { "type": "SSH", "identifier": "ssh-pipeline", "name": "SSH Pipeline", "host": "my-server.tests", "port": "1234", "path": "target/path/on/server", "auth": { "method": "PASSWORD", "username": "my-user", "password": "my-password" }, "tags": [ "ssh", "pipeline" ] } }, "SSH Target (SSH_KEY without passphrase)": { "description": "SSH Target (SSH_KEY without passphrase)", "value": { "type": "SSH", "identifier": "ssh-key-target", "name": "SSH Key Target", "host": "5.75.234.250", "port": "22", "auth": { "method": "SSH_KEY", "username": "sftp-key-0", "key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEA...\n-----END RSA PRIVATE KEY-----" }, "tags": [ "ssh", "key" ] } }, "SSH Target (SSH_KEY with passphrase)": { "description": "SSH Target (SSH_KEY with passphrase)", "value": { "type": "SSH", "identifier": "ssh-key-passphrase-target", "name": "SSH Key with Passphrase Target", "host": "5.75.234.250", "port": "22", "auth": { "method": "SSH_KEY", "username": "sftp-pass-key-phrase-0", "key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEA...\n-----END RSA PRIVATE KEY-----", "passphrase": "key-passphrase" }, "tags": [ "ssh", "key", "passphrase" ] } }, "FTP Target": { "description": "FTP Target", "value": { "type": "FTP", "identifier": "ftp-server", "name": "FTP File Server", "host": "ftp.example.com", "port": "21", "path": "/public_html", "auth": { "username": "ftpuser", "password": "ftppass123" }, "secure": false, "tags": [ "ftp", "files" ] } }, "FTPS Target (Secure FTP)": { "description": "FTPS Target (Secure FTP)", "value": { "type": "FTP", "identifier": "ftps-secure-server", "name": "FTPS Secure File Server", "host": "ftps.example.com", "port": "21", "path": "/var/www/secure", "auth": { "username": "ftpsuser", "password": "ftpspass123" }, "secure": true, "tags": [ "ftps", "secure", "files" ] } }, "Google Kubernetes Engine Target": { "description": "Google Kubernetes Engine Target", "value": { "type": "GKE", "identifier": "gke-production", "name": "GKE Production Cluster", "integration": "google-cloud-integration", "cluster": "production-cluster", "region": "us-central1", "project_id": "my-gcp-project", "zone": "us-central1-a", "tags": [ "kubernetes", "gcp", "production" ] } }, "Amazon Elastic Kubernetes Service Target": { "description": "Amazon Elastic Kubernetes Service Target", "value": { "type": "EKS", "identifier": "eks-staging", "name": "EKS Staging Cluster", "integration": "aws-integration", "cluster": "staging-cluster", "region": "us-west-2", "role_arn": "arn:aws:iam::123456789012:role/eks-service-role", "tags": [ "kubernetes", "aws", "staging" ] } }, "Azure Kubernetes Service Target": { "description": "Azure Kubernetes Service Target", "value": { "type": "AKS", "identifier": "aks-development", "name": "AKS Development Cluster", "integration": "azure-integration", "cluster": "dev-cluster", "region": "eastus", "subscription": "12345678-1234-1234-1234-123456789012", "resource_group": "dev-resource-group", "tags": [ "kubernetes", "azure", "development" ] } }, "DigitalOcean Kubernetes Target": { "description": "DigitalOcean Kubernetes Target", "value": { "type": "DOKS", "identifier": "do-k8s-cluster", "name": "DigitalOcean Kubernetes Cluster", "integration": "digitalocean-integration", "cluster": "do-cluster-prod", "region": "nyc1", "tags": [ "kubernetes", "digitalocean", "production" ] } }, "Amazon EC2 Target": { "description": "Amazon EC2 Target", "value": { "type": "EC2", "identifier": "ec2-web-instances", "name": "EC2 Web Server Instances", "integration": "aws-integration", "region": "us-east-1", "tags": [ "aws", "ec2", "web" ] } }, "DigitalOcean Target": { "description": "DigitalOcean Target", "value": { "type": "DIGITAL_OCEAN", "identifier": "do-droplets", "name": "DigitalOcean Droplets", "integration": "digitalocean-integration", "region": "nyc3", "tags": [ "digitalocean", "droplets" ] } }, "Vultr Target": { "description": "Vultr Target", "value": { "type": "VULTR", "identifier": "vultr-instances", "name": "Vultr Server Instances", "integration": "vultr-integration", "region": "ewr", "tags": [ "vultr", "servers" ] } }, "UpCloud Target": { "description": "UpCloud Target", "value": { "type": "UPCLOUD", "identifier": "upcloud-servers", "name": "UpCloud Servers", "integration": "upcloud-integration", "region": "fi-hel1", "tags": [ "upcloud", "servers" ] } }, "Git Target": { "description": "Git Target", "value": { "type": "GIT", "identifier": "git-repo-target", "name": "Git Repository Target", "repository": "https://github.com/company/project.git", "auth": { "method": "HTTP", "username": "git-user", "password": "ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" }, "tags": [ "git", "repository" ] } }, "Kubernetes Cluster Target": { "description": "Kubernetes Cluster Target", "value": { "type": "K8S_CLUSTER", "identifier": "k8s-production-cluster", "name": "Production Kubernetes Cluster", "cluster": "https://k8s-api.example.com:6443", "auth": { "method": "TOKEN", "token": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjEyMzQ1NiJ9..." }, "tags": [ "kubernetes", "production", "cluster" ] } }, "MySQL Target": { "description": "MySQL Target", "value": { "type": "MYSQL", "identifier": "production-db", "name": "Production MySQL", "host": "db.example.com", "port": 3306, "database": "myapp", "auth": { "method": "PASSWORD", "username": "deploy_user", "password": "secured" }, "tags": [ "mysql", "production" ] } }, "PostgreSQL Target": { "description": "PostgreSQL Target", "value": { "type": "POSTGRESQL", "identifier": "production-pg", "name": "Production PostgreSQL", "host": "pg.example.com", "port": 5432, "database": "myapp", "auth": { "method": "PASSWORD", "username": "deploy_user", "password": "secured" }, "tags": [ "postgresql", "production" ] } }, "MongoDB Target": { "description": "MongoDB Target", "value": { "type": "MONGO", "identifier": "production-mongo", "name": "Production MongoDB", "host": "mongo.example.com", "port": "27017", "database": "myapp", "auth_source": "admin", "auth": { "method": "PASSWORD", "username": "deploy_user", "password": "secured" }, "proxy": { "name": "ssh-bastion" }, "tags": [ "mongodb" ] } }, "MSSQL Target": { "description": "MSSQL Target", "value": { "type": "MSSQL", "identifier": "production-mssql", "name": "Production MSSQL", "host": "mssql.example.com", "port": "1433", "database": "app", "auth": { "method": "PASSWORD", "username": "app_user", "password": "secured" }, "tags": [ "mssql", "production" ] } }, "RDS MSSQL Target": { "description": "RDS MSSQL Target", "value": { "type": "RDS_MSSQL", "identifier": "rds-mssql-prod", "name": "Production MSSQL on RDS", "integration": "aws-prod", "region": "us-east-1", "db_instance_identifier": "my-prod-mssql", "host": "my-prod-mssql.abc123.us-east-1.rds.amazonaws.com", "port": "1433", "database": "production", "ssl_mode": "REQUIRE", "auth": { "method": "PASSWORD", "username": "admin", "password": "secured" }, "tags": [ "rds", "mssql", "production" ] } } } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TargetView" }, "example": { "url": "https://api.buddy.works/workspaces/my-workspace/targets/tg-12345", "html_url": "https://app.buddy.works/targets/tg-12345", "id": "tg-12345", "identifier": "production-web-server", "name": "Production Web Server", "type": "SSH", "host": "web.example.com", "port": "22", "path": "/var/www/html", "auth": { "method": "SSH_KEY", "username": "deploy", "asset": "production-ssh-key" }, "tags": [ "production", "web", "deploy" ], "pipelinesAccessLevel": "DENIED", "allowedPipelines": [ { "project": "my-project", "pipeline": "deploy-pipeline" }, { "project": "my-project", "pipeline": "hotfix-pipeline" } ], "permissions": { "others": "READ_ONLY", "users": [ { "id": 42, "access_level": "USE_ONLY" } ], "groups": [] } } } } } }, "security": [ { "oauth2": [ "TARGET_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/tunnels/token": { "get": { "tags": [ "Tunnel API" ], "summary": "Get or create tunnel token", "operationId": "getTunnelToken", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "query", "description": "The name of the project to get the token for. If not provided, the workspace token is returned", "schema": { "type": "string", "example": "my-project" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TunnelTokenView" }, "example": { "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ3b3Jrc3BhY2VfaWQiOjEyMywidmVyc2lvbiI6MX0.abc123" } } } } }, "security": [ { "oauth2": [ "TUNNEL_INFO" ] } ] }, "post": { "tags": [ "Tunnel API" ], "summary": "Regenerate tunnel token", "operationId": "regenerateTunnelToken", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "query", "description": "The name of the project to get the token for. If not provided, the workspace token is returned", "schema": { "type": "string", "example": "my-project" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TunnelTokenView" }, "example": { "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ3b3Jrc3BhY2VfaWQiOjEyMywidmVyc2lvbiI6MX0.abc123" } } } } }, "security": [ { "oauth2": [ "TUNNEL_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/variables": { "get": { "tags": [ "Variable API" ], "summary": "Returns the list of defined environment variables. If no query params are set, returns only workspace-scoped variables", "operationId": "getVariables", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "project_name", "in": "query", "description": "The name of the project", "schema": { "type": "string", "example": "my-project" } }, { "name": "pipeline_id", "in": "query", "description": "The ID of the pipeline", "schema": { "type": "integer", "format": "int32", "example": 456 } }, { "name": "environment_id", "in": "query", "description": "The ID of the environment", "schema": { "type": "integer", "format": "int32", "example": 789 } }, { "name": "action_id", "in": "query", "description": "The ID of the action", "schema": { "type": "integer", "format": "int32", "example": 101 } }, { "name": "sandbox_id", "in": "query", "description": "The ID of the sandbox", "schema": { "type": "string", "example": "u3ep173pzbjez" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariablesView" }, "example": { "url": "https://api.buddy.works/workspaces/my-company/variables", "html_url": "https://buddy.works/my-company/-/environment-variables", "variables": [ { "url": "https://api.buddy.works/workspaces/my-company/variables/123", "html_url": "https://buddy.works/my-company/-/environment-variables/edit/123", "id": 123, "key": "API_TOKEN", "type": "VAR", "value": "secret-token-value", "encrypted": true, "description": "API token for external service", "settable": true, "run_only_settable": false }, { "url": "https://api.buddy.works/workspaces/my-company/variables/124", "html_url": "https://buddy.works/my-company/-/environment-variables/edit/124", "id": 124, "key": "SSH_KEY", "type": "SSH_KEY", "value": "!encrypted SmFXMKglBP8n...", "encrypted": true, "description": "SSH key for deployment", "settable": false, "file_path": "~/.ssh/id_deploy", "file_chmod": "600", "file_place": "CONTAINER" }, { "url": "https://api.buddy.works/workspaces/my-company/variables/125", "html_url": "https://buddy.works/my-company/-/environment-variables/edit/125", "id": 125, "key": "config_json", "type": "FILE", "value": "eyJhcGlfa2V5IjogIjEyMzQ1Njc4OTAifQ==", "description": "Configuration file", "settable": false, "file_path": "/buddy-variables/config_json", "file_chmod": "644", "file_place": "CONTAINER", "binary": false, "checksum": "a1b2c3d4e5f6" }, { "url": "https://api.buddy.works/workspaces/my-company/variables/126", "html_url": "https://buddy.works/my-company/-/environment-variables/edit/126", "id": 126, "key": "dist_certificate", "type": "IOS_KEYCHAIN", "value": "!encrypted MIIKYgIBAzCCCh4...", "encrypted": true, "description": "Distribution certificate", "settable": false, "key_identifier": "Apple Distribution: My Company (XXXXXXXXXX)", "checksum": "b2c3d4e5f6a1" }, { "url": "https://api.buddy.works/workspaces/my-company/variables/127", "html_url": "https://buddy.works/my-company/-/environment-variables/edit/127", "id": 127, "key": "app_store_profile", "type": "IOS_PROVISION_PROFILES", "value": "!encrypted MIId3gYJKoZIhvc...", "encrypted": true, "description": "App Store provisioning profile", "settable": false, "key_identifier": "App Store Profile", "checksum": "c3d4e5f6a1b2" } ] } } } } }, "security": [ { "oauth2": [ "VARIABLE_INFO" ] } ] }, "post": { "tags": [ "Variable API" ], "summary": "Add a new environment variable", "operationId": "addVariable", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddVariableRequest" }, "examples": { "Project-scoped variable": { "description": "Project-scoped variable", "value": { "key": "my_var", "value": "some value", "project": { "name": "my-project" }, "type": "VAR", "settable": true, "run_only_settable": true } }, "Pipeline-scoped variable": { "description": "Pipeline-scoped variable", "value": { "key": "my_var", "value": "some value", "pipeline": { "id": 1 } } }, "Action-scoped variable": { "description": "Action-scoped variable", "value": { "key": "my_var", "value": "some value", "action": { "id": 1 } } }, "Sandbox-scoped variable": { "description": "Sandbox-scoped variable", "value": { "key": "my_var", "value": "some value", "sandbox": { "id": "u3ep173pzbjez" } } }, "Workspace-scoped SSH key": { "description": "Workspace-scoped SSH key", "value": { "value": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEA...\n-----END RSA PRIVATE KEY-----", "type": "SSH_KEY", "key": "id_my_key", "encrypted": true, "description": "My Server Key", "file_path": "~/.ssh/id_my_key", "file_chmod": "600", "file_place": "CONTAINER" } }, "File variable": { "description": "File variable", "value": { "key": "config_json", "value": "eyJhcGlfa2V5IjogIjEyMzQ1Njc4OTAifQ==", "type": "FILE", "pipeline": { "id": 1 }, "file_path": "/buddy-variables/config_json", "file_chmod": "644", "file_place": "CONTAINER" } }, "iOS keychain certificate": { "description": "iOS keychain certificate", "value": { "key": "dist_certificate", "value": "MIIKYgIBAzCCCh4GCSqGS...", "type": "IOS_KEYCHAIN", "pipeline": { "id": 1 }, "encrypted": true, "password": "certificate-password", "key_identifier": "Apple Distribution: My Company (XXXXXXXXXX)" } }, "iOS provisioning profile": { "description": "iOS provisioning profile", "value": { "key": "app_store_profile", "value": "MIId3gYJKoZIhvcNAQcC...", "type": "IOS_PROVISION_PROFILES", "pipeline": { "id": 1 }, "encrypted": true, "key_identifier": "App Store Profile" } } } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariableView" }, "example": { "url": "https://api.buddy.works/workspaces/my-company/variables/123", "html_url": "https://buddy.works/my-company/-/environment-variables/edit/123", "id": 123, "key": "id_workspace", "type": "SSH_KEY", "encrypted": true, "description": "", "settable": false, "value": "!encrypted SmFXMKglBP8n/3JKGFtjpbOj1RPpHHkGNa+/uoGbeEJXA/D9nALanxozDtshHD8kPjpgfJC8VgXhpC10akKcPnOwOLhpnm0FVK7EQRxaTYd+ZhhiqqINJQXeAQccq52pNtpLVC10qOyWUrYbbD5JguwaIrDI3AnVx/pxOaaSjOVama+6wU6gg0H/2BdOwaiqpGvAkofIMbiROIZkRnO48gU+FEl/+Wkq0nHg0yVdRjX61GWZGNL1tfB+cVBuNLg149yhLJUQY+JVXlGO/562qMYnEk0NMVohauGjRT/4RdJeCx39lOR0VsabMsl9hVU23EXjmcjVzL+fP+PLmjst8bFNRwL+dz2xOhMddIe2YJ4zYp3GXClnMP7DlQn/xyFFFqFS+UQ+AylnCHYTA68cfIqnbAJ23Yout+cRKPUrf2J20iGKdwUANojfabtjyRzjynBcDXALExCmBEOQ63FmKktvOTDx3onH9c37CwRlgoxgePCz4GJHFBqKxaY+LRVcB6q/zsYggdVr785IJnbRfg==.sV8Jqv5sfFL1VJ2lQCwoVg==", "file_path": "~/.ssh/id_toprus", "file_chmod": "600", "file_place": "CONTAINER", "public_value": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIMgI3BdloRSGhzUgdA8FMZjI+sYvRTkTw92lwiFMntUw toprus Key", "key_fingerprint": "59:4e:4a:72:ff:4c:15:36:82:83:11:77:a5:b6:b6:b9", "checksum": "a3114c53b8328869b4f6020559618d56f9522e76763532abfc3a585aaea1f51d" } } } } }, "security": [ { "oauth2": [ "VARIABLE_ADD" ] } ] } }, "/workspaces/{workspace_domain}/variables/{id}": { "get": { "tags": [ "Variable API" ], "summary": "Shows details of the environment variable. Restricted to admins only", "operationId": "getVariable", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "id", "in": "path", "description": "The ID of the variable", "required": true, "schema": { "type": "integer", "format": "int32", "example": 123 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariableView" }, "example": { "url": "https://api.buddy.works/workspaces/my-company/variables/123", "html_url": "https://buddy.works/my-company/-/environment-variables/edit/123", "id": 123, "key": "id_workspace", "type": "SSH_KEY", "encrypted": true, "description": "", "settable": false, "value": "!encrypted SmFXMKglBP8n/3JKGFtjpbOj1RPpHHkGNa+/uoGbeEJXA/D9nALanxozDtshHD8kPjpgfJC8VgXhpC10akKcPnOwOLhpnm0FVK7EQRxaTYd+ZhhiqqINJQXeAQccq52pNtpLVC10qOyWUrYbbD5JguwaIrDI3AnVx/pxOaaSjOVama+6wU6gg0H/2BdOwaiqpGvAkofIMbiROIZkRnO48gU+FEl/+Wkq0nHg0yVdRjX61GWZGNL1tfB+cVBuNLg149yhLJUQY+JVXlGO/562qMYnEk0NMVohauGjRT/4RdJeCx39lOR0VsabMsl9hVU23EXjmcjVzL+fP+PLmjst8bFNRwL+dz2xOhMddIe2YJ4zYp3GXClnMP7DlQn/xyFFFqFS+UQ+AylnCHYTA68cfIqnbAJ23Yout+cRKPUrf2J20iGKdwUANojfabtjyRzjynBcDXALExCmBEOQ63FmKktvOTDx3onH9c37CwRlgoxgePCz4GJHFBqKxaY+LRVcB6q/zsYggdVr785IJnbRfg==.sV8Jqv5sfFL1VJ2lQCwoVg==", "file_path": "~/.ssh/id_toprus", "file_chmod": "600", "file_place": "CONTAINER", "public_value": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIMgI3BdloRSGhzUgdA8FMZjI+sYvRTkTw92lwiFMntUw toprus Key", "key_fingerprint": "59:4e:4a:72:ff:4c:15:36:82:83:11:77:a5:b6:b6:b9", "checksum": "a3114c53b8328869b4f6020559618d56f9522e76763532abfc3a585aaea1f51d" } } } } }, "security": [ { "oauth2": [ "VARIABLE_INFO" ] } ] }, "delete": { "tags": [ "Variable API" ], "summary": "Delete a variable", "operationId": "deleteVariable", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "id", "in": "path", "description": "The ID of the variable", "required": true, "schema": { "type": "integer", "format": "int32", "example": 123 } } ], "responses": { "default": { "description": "default response", "content": { "application/json": {} } } }, "security": [ { "oauth2": [ "VARIABLE_MANAGE" ] } ] }, "patch": { "tags": [ "Variable API" ], "summary": "Edits an environment variable", "operationId": "updateVariable", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "id", "in": "path", "description": "The ID of the variable", "required": true, "schema": { "type": "integer", "format": "int32", "example": 123 } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVariableRequest" }, "example": { "key": "API_TOKEN_UPDATED", "value": "new-secret-token-value", "encrypted": true, "description": "Updated API token for external service", "settable": true, "disabled": true } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariableView" }, "example": { "url": "https://api.buddy.works/workspaces/my-company/variables/123", "html_url": "https://buddy.works/my-company/-/environment-variables/edit/123", "id": 123, "key": "id_workspace", "type": "SSH_KEY", "encrypted": true, "description": "", "settable": false, "value": "!encrypted SmFXMKglBP8n/3JKGFtjpbOj1RPpHHkGNa+/uoGbeEJXA/D9nALanxozDtshHD8kPjpgfJC8VgXhpC10akKcPnOwOLhpnm0FVK7EQRxaTYd+ZhhiqqINJQXeAQccq52pNtpLVC10qOyWUrYbbD5JguwaIrDI3AnVx/pxOaaSjOVama+6wU6gg0H/2BdOwaiqpGvAkofIMbiROIZkRnO48gU+FEl/+Wkq0nHg0yVdRjX61GWZGNL1tfB+cVBuNLg149yhLJUQY+JVXlGO/562qMYnEk0NMVohauGjRT/4RdJeCx39lOR0VsabMsl9hVU23EXjmcjVzL+fP+PLmjst8bFNRwL+dz2xOhMddIe2YJ4zYp3GXClnMP7DlQn/xyFFFqFS+UQ+AylnCHYTA68cfIqnbAJ23Yout+cRKPUrf2J20iGKdwUANojfabtjyRzjynBcDXALExCmBEOQ63FmKktvOTDx3onH9c37CwRlgoxgePCz4GJHFBqKxaY+LRVcB6q/zsYggdVr785IJnbRfg==.sV8Jqv5sfFL1VJ2lQCwoVg==", "file_path": "~/.ssh/id_toprus", "file_chmod": "600", "file_place": "CONTAINER", "public_value": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIMgI3BdloRSGhzUgdA8FMZjI+sYvRTkTw92lwiFMntUw toprus Key", "key_fingerprint": "59:4e:4a:72:ff:4c:15:36:82:83:11:77:a5:b6:b6:b9", "checksum": "a3114c53b8328869b4f6020559618d56f9522e76763532abfc3a585aaea1f51d" } } } } }, "security": [ { "oauth2": [ "VARIABLE_MANAGE" ] } ] } }, "/workspaces/{workspace_domain}/webhooks": { "get": { "tags": [ "Webhook API" ], "summary": "Get all webhooks in the workspace", "operationId": "getWebhooks", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksView" }, "example": { "url": "https://api.buddy.works/workspaces/my-company/webhooks", "html_url": "https://app.buddy.works/my-company/-/workspace/integrations", "webhooks": [ { "url": "https://api.buddy.works/workspaces/my-company/webhooks/123", "html_url": "https://app.buddy.works/my-company/-/workspace/integrations/123", "id": 123, "target_url": "https://example.com/webhook", "name": "CI Webhook" }, { "url": "https://api.buddy.works/workspaces/my-company/webhooks/124", "html_url": "https://app.buddy.works/my-company/-/workspace/integrations/124", "id": 124, "target_url": "https://slack.com/webhook/123", "name": "Slack Notifications" } ] } } } } }, "security": [ { "oauth2": [ "WEBHOOK_INFO" ] } ] }, "post": { "tags": [ "Webhook API" ], "summary": "Creates a new webhook. Restricted to admins only.", "operationId": "addWebhook", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddUpdateWebhookRequest" }, "example": { "target_url": "https://example.com/webhook", "secret_key": "my-secret-key", "name": "CI Webhook", "projects": [ "my-project", "api-project" ], "events": [ "PUSH", "EXECUTION_STARTED", "EXECUTION_SUCCESSFUL", "EXECUTION_FAILED" ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookView" }, "example": { "url": "https://api.buddy.works/workspaces/my-company/webhooks/244", "html_url": "https://app.buddy.works/my-company/-/workspace/integrations/244", "id": 244, "target_url": "https://dupal.free.beeceptor.com", "secret_key": "tarzan", "name": "my webhook", "projects": [ "visual-test-example-project" ], "events": [ "EXECUTION_STARTED", "EXECUTION_SUCCESSFUL", "EXECUTION_FAILED", "EXECUTION_FINISHED", "PUSH" ], "requests": [ { "post_date": "2025-09-25T05:07:12Z", "response_status": 200, "body": "" }, { "post_date": "2025-09-25T05:07:02Z", "response_status": 200, "body": "" } ] } } } } }, "security": [ { "oauth2": [ "WEBHOOK_ADD" ] } ] } }, "/workspaces/{workspace_domain}/webhooks/{id}": { "get": { "tags": [ "Webhook API" ], "summary": "Get a specific webhook by ID", "operationId": "getWebhook", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "id", "in": "path", "description": "The ID of the webhook", "required": true, "schema": { "type": "integer", "format": "int32", "example": 123 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookView" }, "example": { "url": "https://api.buddy.works/workspaces/my-company/webhooks/244", "html_url": "https://app.buddy.works/my-company/-/workspace/integrations/244", "id": 244, "target_url": "https://dupal.free.beeceptor.com", "secret_key": "tarzan", "name": "my webhook", "projects": [ "visual-test-example-project" ], "events": [ "EXECUTION_STARTED", "EXECUTION_SUCCESSFUL", "EXECUTION_FAILED", "EXECUTION_FINISHED", "PUSH" ], "requests": [ { "post_date": "2025-09-25T05:07:12Z", "response_status": 200, "body": "" }, { "post_date": "2025-09-25T05:07:02Z", "response_status": 200, "body": "" } ] } } } } }, "security": [ { "oauth2": [ "WEBHOOK_INFO" ] } ] }, "delete": { "tags": [ "Webhook API" ], "summary": "Delete a webhook", "operationId": "deleteWebhook", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "id", "in": "path", "description": "The ID of the webhook", "required": true, "schema": { "type": "integer", "format": "int32", "example": 123 } } ], "responses": { "default": { "description": "default response", "content": { "application/json": {} } } }, "security": [ { "oauth2": [ "WEBHOOK_MANAGE" ] } ] }, "patch": { "tags": [ "Webhook API" ], "summary": "Update webhook configuration", "operationId": "updateWebhook", "parameters": [ { "name": "workspace_domain", "in": "path", "description": "The human-readable ID of the workspace", "required": true, "schema": { "type": "string", "example": "my-company" } }, { "name": "id", "in": "path", "description": "The ID of the webhook", "required": true, "schema": { "type": "integer", "format": "int32", "example": 123 } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddUpdateWebhookRequest" }, "example": { "target_url": "https://example.com/updated-webhook", "secret_key": "updated-secret-key", "name": "Updated CI Webhook", "projects": [ "my-project", "api-project", "new-project" ], "events": [ "PUSH", "EXECUTION_STARTED", "EXECUTION_SUCCESSFUL", "EXECUTION_FAILED" ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookView" }, "example": { "url": "https://api.buddy.works/workspaces/my-company/webhooks/244", "html_url": "https://app.buddy.works/my-company/-/workspace/integrations/244", "id": 244, "target_url": "https://dupal.free.beeceptor.com", "secret_key": "tarzan", "name": "my webhook", "projects": [ "visual-test-example-project" ], "events": [ "EXECUTION_STARTED", "EXECUTION_SUCCESSFUL", "EXECUTION_FAILED", "EXECUTION_FINISHED", "PUSH" ], "requests": [ { "post_date": "2025-09-25T05:07:12Z", "response_status": 200, "body": "" }, { "post_date": "2025-09-25T05:07:02Z", "response_status": 200, "body": "" } ] } } } } }, "security": [ { "oauth2": [ "WEBHOOK_MANAGE" ] } ] } } }, "components": { "schemas": { "AllowedPipelineView": { "required": [ "pipeline", "project" ], "type": "object", "properties": { "project": { "type": "string", "description": "Project name", "example": "my-project" }, "pipeline": { "type": "string", "description": "Pipeline identifier", "example": "deploy-pipeline" }, "access_level": { "type": "string", "description": "Access level for the allowed pipeline. Project repository targets: `DENIED`, `READ_ONLY`, `READ_WRITE`. Other targets: `DENIED`, `USE_ONLY`", "example": "READ_WRITE", "enum": [ "DENIED", "READ_ONLY", "USE_ONLY", "BLIND", "RUN_ONLY", "READ_WRITE", "MANAGE", "DEFAULT", "ALLOWED", "STAGE", "COMMIT" ] } }, "description": "List of specific pipelines allowed to use this target" }, "AllowedSandboxView": { "required": [ "project", "sandbox" ], "type": "object", "properties": { "project": { "type": "string", "description": "Project name", "example": "my-project" }, "sandbox": { "type": "string", "description": "Sandbox identifier", "example": "my-sandbox" }, "access_level": { "type": "string", "description": "Access level for the allowed sandbox: `DENIED`, `READ_ONLY`, `READ_WRITE`", "example": "READ_WRITE", "enum": [ "DENIED", "READ_ONLY", "USE_ONLY", "BLIND", "RUN_ONLY", "READ_WRITE", "MANAGE", "DEFAULT", "ALLOWED", "STAGE", "COMMIT" ] } }, "description": "List of specific sandboxes allowed to use this target" }, "ArtifactGroupPermissionView": { "required": [ "access_level", "id" ], "type": "object", "properties": { "id": { "type": "integer", "description": "Group ID", "format": "int32", "example": 15 }, "access_level": { "type": "string", "description": "Access level for the group", "example": "READ_ONLY", "enum": [ "DENIED", "READ_ONLY", "READ_WRITE", "MANAGE", "DEFAULT" ] } }, "description": "Group-specific permissions" }, "ArtifactPermissionsView": { "type": "object", "properties": { "others": { "type": "string", "description": "Permission level for others", "example": "READ_ONLY", "enum": [ "DENIED", "READ_ONLY", "READ_WRITE", "MANAGE", "DEFAULT" ] }, "users": { "type": "array", "description": "List of user-specific permissions for the artifact", "items": { "$ref": "#/components/schemas/ArtifactUserPermissionView" } }, "groups": { "type": "array", "description": "List of group-specific permissions for the artifact", "items": { "$ref": "#/components/schemas/ArtifactGroupPermissionView" } } }, "description": "Artifact permissions configuration" }, "ArtifactUserPermissionView": { "required": [ "access_level", "id" ], "type": "object", "properties": { "id": { "type": "integer", "description": "User ID", "format": "int32", "example": 42 }, "access_level": { "type": "string", "description": "Access level for the user", "example": "MANAGE", "enum": [ "DENIED", "READ_ONLY", "READ_WRITE", "MANAGE", "DEFAULT" ] } }, "description": "User-specific permissions" }, "AuthorizationView": { "required": [ "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "The type of authorization. BASIC can only be used with FILES type artifacts.", "default": "BUDDY", "enum": [ "NONE", "BUDDY", "BASIC" ] }, "user": { "type": "string", "description": "Username for BASIC auth (required when type is BASIC)", "example": "myuser" }, "password": { "type": "string", "description": "Password for BASIC auth (required when type is BASIC)", "example": "secret123" } }, "description": "Artifact authorization configuration. Password is only used in requests and not returned in responses. BASIC authorization can only be used with FILES type artifacts." }, "CreateArtifactRequest": { "required": [ "authorization", "name", "scope", "type" ], "type": "object", "properties": { "name": { "type": "string", "description": "The display name of the artifact", "example": "my_project_artifact" }, "identifier": { "type": "string", "description": "The human-readable identifier of the artifact", "example": "my-project-artifact" }, "type": { "type": "string", "description": "The type of artifact", "example": "CONTAINER", "enum": [ "CONTAINER", "BUCKET", "NPM" ] }, "scope": { "type": "string", "description": "The scope level of the artifact", "example": "PROJECT", "enum": [ "WORKSPACE", "PROJECT", "ENVIRONMENT" ] }, "project": { "$ref": "#/components/schemas/ProjectReferenceView" }, "environment": { "$ref": "#/components/schemas/EnvironmentReferenceView" }, "authorization": { "$ref": "#/components/schemas/AuthorizationView" }, "permissions": { "$ref": "#/components/schemas/ArtifactPermissionsView" }, "allowed_pipelines": { "type": "array", "description": "List of pipelines allowed to access this artifact", "items": { "$ref": "#/components/schemas/AllowedPipelineView" } }, "pipelines_access_level": { "type": "string", "description": "Set to `true` to allow all pipelines to use this artifact", "example": "READ_ONLY", "enum": [ "DENIED", "READ_ONLY", "USE_ONLY", "BLIND", "RUN_ONLY", "READ_WRITE", "MANAGE", "DEFAULT", "ALLOWED", "STAGE", "COMMIT" ] }, "allowed_sandboxes": { "type": "array", "description": "List of sandboxes allowed to access this package", "items": { "$ref": "#/components/schemas/AllowedSandboxView" } }, "sandboxes_access_level": { "type": "string", "description": "Default access level for all sandboxes", "example": "DENIED", "enum": [ "DENIED", "READ_ONLY", "USE_ONLY", "BLIND", "RUN_ONLY", "READ_WRITE", "MANAGE", "DEFAULT", "ALLOWED", "STAGE", "COMMIT" ] } }, "description": "Required fields: name, type, scope. BASIC authorization can only be used with FILES type artifacts." }, "EnvironmentReferenceView": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "description": "The ID of the environment", "format": "int32" } }, "description": "Environment reference for artifact creation/update" }, "ProjectReferenceView": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "The name of the project", "example": "my-project" } }, "description": "Project reference for artifact creation/update" }, "ArtifactRetentionRuleView": { "type": "object", "properties": { "id": { "type": "integer", "description": "The unique ID of the retention rule", "format": "int32", "example": 1 }, "type": { "type": "string", "description": "The type of retention rule", "example": "KEEP_BY_COUNT", "enum": [ "KEEP_ALL", "KEEP_BY_COUNT", "KEEP_BY_DATE" ] }, "value": { "type": "integer", "description": "The value for the retention rule (e.g., number of versions to keep or number of days)", "format": "int32", "example": 10 }, "tag_filter": { "type": "string", "description": "Regex pattern to filter artifact versions by tag. Only matching versions are affected by this rule.", "example": "^v\\d+\\.\\d+\\.\\d+$" } }, "description": "Artifact retention rule configuration" }, "ArtifactView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The unique ID of the artifact", "format": "int32" }, "type": { "type": "string", "description": "The type of artifact", "example": "CONTAINER", "enum": [ "CONTAINER", "BUCKET", "NPM" ] }, "name": { "type": "string", "description": "The display name of the artifact", "example": "My Application Artifact" }, "identifier": { "type": "string", "description": "The human-readable identifier of the artifact", "example": "my-app-artifact" }, "scope": { "type": "string", "description": "The scope level of the artifact", "example": "WORKSPACE", "enum": [ "WORKSPACE", "PROJECT", "ENVIRONMENT" ] }, "size": { "type": "integer", "description": "Total size of all artifact versions in bytes", "format": "int64", "example": 1048576000 }, "project": { "$ref": "#/components/schemas/ShortProjectView" }, "environment": { "$ref": "#/components/schemas/ShortEnvironmentView" }, "authorization": { "$ref": "#/components/schemas/AuthorizationView" }, "permissions": { "$ref": "#/components/schemas/ArtifactPermissionsView" }, "allowed_pipelines": { "type": "array", "description": "List of pipelines allowed to access this artifact", "items": { "$ref": "#/components/schemas/AllowedPipelineView" } }, "pipelines_access_level": { "type": "string", "description": "Set to `true` to allow all pipelines to use this artifact", "example": "READ_ONLY", "enum": [ "DENIED", "READ_ONLY", "USE_ONLY", "BLIND", "RUN_ONLY", "READ_WRITE", "MANAGE", "DEFAULT", "ALLOWED", "STAGE", "COMMIT" ] }, "allowed_sandboxes": { "type": "array", "description": "List of sandboxes allowed to access this package", "items": { "$ref": "#/components/schemas/AllowedSandboxView" } }, "sandboxes_access_level": { "type": "string", "description": "Default access level for all sandboxes", "example": "DENIED", "enum": [ "DENIED", "READ_ONLY", "USE_ONLY", "BLIND", "RUN_ONLY", "READ_WRITE", "MANAGE", "DEFAULT", "ALLOWED", "STAGE", "COMMIT" ] }, "created_date": { "type": "string", "description": "Artifact creation timestamp", "format": "date-time", "example": "2024-01-22T09:15:00Z" }, "retention_rules": { "type": "array", "description": "List of retention rules for automatic cleanup of artifact versions", "items": { "$ref": "#/components/schemas/ArtifactRetentionRuleView" } } }, "description": "Full artifact representation" }, "ShortEnvironmentView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "name": { "type": "string", "description": "The name of the environment", "example": "staging" }, "identifier": { "type": "string", "description": "The human-readable identifier of the environment", "example": "my-staging" }, "id": { "type": "integer", "description": "The ID of the environment", "format": "int32" }, "scope": { "type": "string", "description": "The scope level of the environment", "example": "PROJECT", "enum": [ "PROJECT", "WORKSPACE", "ANY" ] } }, "description": "Short representation of an environment object" }, "ShortProjectView": { "required": [ "display_name" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "name": { "type": "string", "description": "The human-readable ID of the project", "example": "my-project" }, "display_name": { "type": "string", "description": "The Name of the project", "example": "My Project" }, "status": { "type": "string", "description": "The status of the project" }, "access": { "type": "string", "description": "Indicates if this is a public project", "enum": [ "PRIVATE", "PUBLIC" ] }, "create_date": { "type": "string", "description": "The creation date of the project", "format": "date-time" } }, "description": "Short representation of a project" }, "ArtifactsView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "artifacts": { "type": "array", "items": { "$ref": "#/components/schemas/ShortArtifactView" } } }, "description": "Container for artifact lists" }, "ShortArtifactView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The unique ID of the artifact", "format": "int32" }, "type": { "type": "string", "description": "The type of artifact", "example": "CONTAINER", "enum": [ "CONTAINER", "BUCKET", "NPM" ] }, "name": { "type": "string", "description": "The display name of the artifact", "example": "My Application Artifact" }, "identifier": { "type": "string", "description": "The human-readable identifier of the artifact", "example": "my-app-artifact" }, "scope": { "type": "string", "description": "The scope level of the artifact", "example": "WORKSPACE", "enum": [ "WORKSPACE", "PROJECT", "ENVIRONMENT" ] }, "size": { "type": "integer", "description": "Total size of all artifact versions in bytes", "format": "int64", "example": 1048576000 } }, "description": "Short representation of a artifact object" }, "UpdateArtifactRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "The display name of the artifact. Can only be changed if artifact type is FILES.", "example": "Updated Artifact Name" }, "identifier": { "type": "string", "description": "The human-readable identifier of the artifact", "example": "updated-artifact-name" }, "project": { "$ref": "#/components/schemas/ProjectReferenceView" }, "environment": { "$ref": "#/components/schemas/EnvironmentReferenceView" }, "scope": { "type": "string", "description": "The scope level of the artifact. Can only be changed to a higher level: ENVIRONMENT→PROJECT or WORKSPACE, PROJECT→WORKSPACE", "example": "WORKSPACE" }, "authorization": { "$ref": "#/components/schemas/AuthorizationView" }, "permissions": { "$ref": "#/components/schemas/ArtifactPermissionsView" }, "allowed_pipelines": { "type": "array", "description": "List of pipelines allowed to access this artifact", "items": { "$ref": "#/components/schemas/AllowedPipelineView" } }, "pipelines_access_level": { "type": "string", "description": "Set to `true` to allow all pipelines to use this artifact", "example": "READ_ONLY", "enum": [ "DENIED", "READ_ONLY", "USE_ONLY", "BLIND", "RUN_ONLY", "READ_WRITE", "MANAGE", "DEFAULT", "ALLOWED", "STAGE", "COMMIT" ] }, "retention_rules": { "type": "array", "description": "List of retention rules for automatic cleanup of artifact versions", "items": { "$ref": "#/components/schemas/ArtifactRetentionRuleView" } }, "allowed_sandboxes": { "type": "array", "description": "List of sandboxes allowed to access this package", "items": { "$ref": "#/components/schemas/AllowedSandboxView" } }, "sandboxes_access_level": { "type": "string", "description": "Default access level for all sandboxes", "example": "DENIED", "enum": [ "DENIED", "READ_ONLY", "USE_ONLY", "BLIND", "RUN_ONLY", "READ_WRITE", "MANAGE", "DEFAULT", "ALLOWED", "STAGE", "COMMIT" ] } }, "description": "Update artifact fields. Restrictions: name can only be changed if artifact type is FILES, scope can only be changed to higher levels (ENVIRONMENT→PROJECT/WORKSPACE, PROJECT→WORKSPACE), type cannot be changed, BASIC authorization can only be used with FILES type artifacts." }, "CreateArtifactVersionRequest": { "required": [ "version" ], "type": "object", "properties": { "version": { "type": "string", "description": "The version identifier (e.g., latest, v1.2.0, stable)", "example": "v1.2.1" } }, "description": "Request to create a new artifact version" }, "ArtifactVersionView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The unique ID of the version (used in API endpoints)", "format": "int32" }, "version": { "type": "string", "description": "The version identifier (e.g., latest, v1.2.0, stable)", "example": "latest" }, "size": { "type": "integer", "description": "Size of the version content in bytes", "format": "int64", "example": 1048576 }, "version_url": { "type": "string", "description": "Direct URL to access the artifact version content. For CONTAINER artifacts, this is the registry URL (e.g., container.registry.sh/ttests/ubuntu:latest). For FILES artifacts, this is the HTTP server URL where the content is served (e.g., https://latest-my-artifact.bucket-1.registry.sh/)", "example": "https://latest-my-artifact.bucket-1.registry.sh/" }, "created_date": { "type": "string", "description": "Version creation timestamp", "format": "date-time", "example": "2024-01-20T10:30:00Z" } }, "description": "Full representation of a artifact version" }, "ArtifactVersionContentItem": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "type": { "type": "string", "description": "Type of the content item", "example": "FILE", "enum": [ "FILE", "DIR" ] }, "name": { "type": "string", "description": "File or directory name", "example": "README.md" }, "path": { "type": "string", "description": "Full path to the file or directory", "example": "/dir/README.md" }, "size": { "type": "integer", "description": "Size in bytes. Only present when type=FILE.", "format": "int64", "example": 2048 } }, "description": "A file or directory item within a artifact version" }, "ArtifactVersionContentView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "contents": { "type": "array", "description": "Array of content items. Contains one element when requesting a specific file, multiple elements when requesting a directory.", "items": { "$ref": "#/components/schemas/ArtifactVersionContentItem" } } }, "description": "Artifact version content listing. Contains one element when requesting a specific file, multiple elements when requesting a directory." }, "ArtifactVersionsView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "versions": { "type": "array", "description": "List of artifact versions", "items": { "$ref": "#/components/schemas/ShortArtifactVersionView" } } }, "description": "Collection of artifact versions" }, "ShortArtifactVersionView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The unique ID of the version (used in API endpoints)", "format": "int32" }, "version": { "type": "string", "description": "The version identifier (e.g., latest, v1.2.0, stable)", "example": "latest" }, "size": { "type": "integer", "description": "Size of the version content in bytes", "format": "int64", "example": 1048576 }, "version_url": { "type": "string", "description": "Direct URL to access the artifact version content. For CONTAINER artifacts, this is the registry URL (e.g., container.registry.sh/ttests/ubuntu:latest). For FILES artifacts, this is the HTTP server URL where the content is served (e.g., https://latest-my-artifact.bucket-1.registry.sh/)", "example": "https://latest-my-artifact.bucket-1.registry.sh/" }, "created_date": { "type": "string", "description": "Version creation timestamp", "format": "date-time", "example": "2024-01-20T10:30:00Z" } }, "description": "Short representation of a artifact version for list views" }, "CrawlSuiteCookieView": { "type": "object", "properties": { "scope": { "type": "string", "description": "URL scope for the cookie" }, "key": { "type": "string", "description": "Cookie name" }, "value": { "type": "string", "description": "Cookie value" }, "http_only": { "type": "boolean", "description": "Whether the cookie is HTTP-only" }, "secure": { "type": "boolean", "description": "Whether the cookie requires HTTPS" }, "domain": { "type": "string", "description": "The domain for which the cookie is valid" }, "path": { "type": "string", "description": "The path on the server to which the cookie applies" }, "same_site": { "type": "string", "description": "SameSite attribute: strict, lax, or none" } }, "description": "Cookies to set before crawling" }, "CrawlSuiteDelayView": { "type": "object", "properties": { "scope": { "type": "string", "description": "URL scope for the delay" }, "value": { "type": "integer", "description": "Delay value in milliseconds (0-60000)", "format": "int32" } }, "description": "Delays configuration for the crawl" }, "CrawlSuiteDeviceView": { "type": "object", "properties": { "name": { "type": "string", "description": "The device name" }, "viewport": { "$ref": "#/components/schemas/DeviceScreenView" }, "screen": { "$ref": "#/components/schemas/DeviceScreenView" }, "device_pixel_ratio": { "type": "number", "description": "The device pixel ratio", "format": "float" }, "is_mobile": { "type": "boolean", "description": "Whether the device is mobile" }, "default_browser": { "type": "string", "description": "The default browser for the device" } }, "description": "List of devices to crawl on" }, "CrawlSuiteHeaderView": { "type": "object", "properties": { "scope": { "type": "string", "description": "URL scope for the header" }, "key": { "type": "string", "description": "Header name" }, "value": { "type": "string", "description": "Header value" } }, "description": "Request headers to set before crawling" }, "CrawlSuiteLocalStorageView": { "type": "object", "properties": { "scope": { "type": "string", "description": "URL scope for the local storage item" }, "key": { "type": "string", "description": "Local storage key" }, "value": { "type": "string", "description": "Local storage value" } }, "description": "Local storage items to set before crawling" }, "CrawlSuiteOutputView": { "type": "object", "properties": { "type": { "type": "string", "description": "The output type", "enum": [ "HTML", "MD", "PNG", "JPEG" ] }, "selector": { "$ref": "#/components/schemas/CrawlSuiteSelectorView" }, "quality": { "type": "integer", "description": "Image quality (1-100). Applicable to JPEG and PNG", "format": "int32" }, "full_page": { "type": "boolean", "description": "Capture the full page. Default: false" } }, "description": "Output configuration for the crawl" }, "CrawlSuiteSelectorView": { "type": "object", "properties": { "type": { "type": "string", "description": "The selector type", "enum": [ "CSS", "XPATH" ] }, "value": { "type": "string", "description": "The selector expression" } }, "description": "CSS or XPath selector to capture a specific element" }, "CrawlSuiteView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "string", "description": "Unique identifier of the crawl suite" }, "identifier": { "type": "string", "description": "Unique identifier for the suite (auto-generated if not provided)" }, "name": { "type": "string", "description": "Name of the crawl suite" }, "full_page": { "type": "boolean", "description": "Whether to capture the full page" }, "color_scheme": { "type": "string", "description": "Color scheme for the crawl", "enum": [ "LIGHT", "DARK", "LIGHT_AND_DARK" ] }, "device_type": { "type": "string", "description": "Device type for the crawl", "enum": [ "EMULATED", "REAL" ] }, "devices": { "type": "array", "description": "List of devices to crawl on", "items": { "$ref": "#/components/schemas/CrawlSuiteDeviceView" } }, "desktop_browsers": { "type": "array", "description": "List of desktop browsers to crawl on", "items": { "type": "string", "description": "List of desktop browsers to crawl on" } }, "desktop_system": { "type": "string", "description": "Desktop system for the crawl", "enum": [ "WINDOWS", "MACOS", "UBUNTU" ] }, "cookies": { "type": "array", "description": "Cookies to set before crawling", "items": { "$ref": "#/components/schemas/CrawlSuiteCookieView" } }, "request_headers": { "type": "array", "description": "Request headers to set before crawling", "items": { "$ref": "#/components/schemas/CrawlSuiteHeaderView" } }, "local_storage": { "type": "array", "description": "Local storage items to set before crawling", "items": { "$ref": "#/components/schemas/CrawlSuiteLocalStorageView" } }, "delays": { "type": "array", "description": "Delays configuration for the crawl", "items": { "$ref": "#/components/schemas/CrawlSuiteDelayView" } }, "wait_for_selectors": { "type": "array", "description": "Selectors to wait for before crawling", "items": { "$ref": "#/components/schemas/CrawlSuiteWaitForSelectorView" } }, "outputs": { "type": "array", "description": "Output configuration for the crawl", "items": { "$ref": "#/components/schemas/CrawlSuiteOutputView" } }, "ignored_urls": { "type": "array", "description": "URLs to ignore during crawling", "items": { "type": "string", "description": "URLs to ignore during crawling" } }, "project_name": { "type": "string", "description": "Name of the project the suite belongs to" }, "concurrents_limit": { "type": "integer", "description": "Maximum number of concurrent crawls", "format": "int32" }, "create_date": { "type": "integer", "description": "Creation date of the suite (Unix timestamp)", "format": "int64" }, "last_update_date": { "type": "integer", "description": "Last update date of the suite (Unix timestamp)", "format": "int64" }, "session_count": { "type": "integer", "description": "Number of sessions in the suite", "format": "int32" }, "crawl_url": { "type": "string", "description": "URL to crawl" }, "follow": { "type": "boolean", "description": "Whether to follow links during crawling" }, "respect_robots": { "type": "boolean", "description": "Whether to respect robots.txt rules" }, "token": { "type": "string", "description": "Authentication token for the suite" } } }, "CrawlSuiteWaitForSelectorView": { "type": "object", "properties": { "type": { "type": "string", "description": "The selector type", "enum": [ "XPATH", "CSS" ] }, "scope": { "type": "string", "description": "URL scope for the selector" }, "value": { "type": "string", "description": "The selector expression" } }, "description": "Selectors to wait for before crawling" }, "DeviceScreenView": { "type": "object", "properties": { "width": { "type": "integer", "description": "Screen width in pixels", "format": "int32" }, "height": { "type": "integer", "description": "Screen height in pixels", "format": "int32" } }, "description": "The screen dimensions" }, "AddCrawlSuiteRequestView": { "type": "object", "properties": { "identifier": { "type": "string", "description": "Unique identifier for the suite (auto-generated if not provided)" }, "name": { "type": "string", "description": "Name of the crawl suite" }, "full_page": { "type": "boolean", "description": "Whether to capture the full page" }, "color_scheme": { "type": "string", "description": "Color scheme for the crawl", "enum": [ "LIGHT", "DARK", "LIGHT_AND_DARK" ] }, "device_type": { "type": "string", "description": "Device type for the crawl", "enum": [ "EMULATED", "REAL" ] }, "devices": { "type": "array", "description": "List of devices to crawl on", "items": { "$ref": "#/components/schemas/CrawlSuiteDeviceView" } }, "desktop_browsers": { "type": "array", "description": "List of desktop browsers to crawl on", "items": { "type": "string", "description": "List of desktop browsers to crawl on" } }, "desktop_system": { "type": "string", "description": "Desktop system for the crawl", "enum": [ "WINDOWS", "MACOS", "UBUNTU" ] }, "cookies": { "type": "array", "description": "Cookies to set before crawling", "items": { "$ref": "#/components/schemas/CrawlSuiteCookieView" } }, "request_headers": { "type": "array", "description": "Request headers to set before crawling", "items": { "$ref": "#/components/schemas/CrawlSuiteHeaderView" } }, "local_storage": { "type": "array", "description": "Local storage items to set before crawling", "items": { "$ref": "#/components/schemas/CrawlSuiteLocalStorageView" } }, "delays": { "type": "array", "description": "Delays configuration for the crawl", "items": { "$ref": "#/components/schemas/CrawlSuiteDelayView" } }, "wait_for_selectors": { "type": "array", "description": "Selectors to wait for before crawling", "items": { "$ref": "#/components/schemas/CrawlSuiteWaitForSelectorView" } }, "outputs": { "type": "array", "description": "Output configuration for the crawl", "items": { "$ref": "#/components/schemas/CrawlSuiteOutputView" } }, "ignored_urls": { "type": "array", "description": "URLs to ignore during crawling", "items": { "type": "string", "description": "URLs to ignore during crawling" } }, "url": { "type": "string", "description": "URL to crawl" }, "follow": { "type": "boolean", "description": "Whether to follow links during crawling" }, "respect_robots": { "type": "boolean", "description": "Whether to respect robots.txt rules" } } }, "CrawlSessionView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "string", "description": "Unique identifier of the crawl session" }, "status": { "type": "string", "description": "Status of the crawl session", "enum": [ "IN_PROGRESS", "ERROR", "TERMINATED", "FINISHED" ] }, "session_number": { "type": "integer", "description": "Sequential number of the session", "format": "int32" }, "pipeline_id": { "type": "integer", "description": "ID of the pipeline that triggered the session", "format": "int32" }, "pipeline_name": { "type": "string", "description": "Name of the pipeline that triggered the session" }, "execution_id": { "type": "string", "description": "ID of the execution that triggered the session" }, "action_id": { "type": "integer", "description": "ID of the action that triggered the session", "format": "int32" }, "creator_id": { "type": "integer", "description": "ID of the user who created the session", "format": "int32" }, "ci_provider": { "type": "string", "description": "CI provider that triggered the session", "enum": [ "NONE", "BUDDY", "GITHUB_ACTION", "CIRCLE_CI" ] }, "suite_id": { "type": "string", "description": "ID of the suite the session belongs to" }, "create_date": { "type": "integer", "description": "Creation date of the session (Unix timestamp)", "format": "int64" }, "status_change_date": { "type": "integer", "description": "Date of the last status change (Unix timestamp)", "format": "int64" }, "cli_version": { "type": "string", "description": "CLI version used for the session" }, "run_id": { "type": "string", "description": "Run ID of the session" }, "run_url": { "type": "string", "description": "Run URL of the session" }, "comment": { "type": "string", "description": "Comment for the session" }, "urls_count": { "type": "integer", "description": "Number of URLs crawled in the session", "format": "int32" }, "name": { "type": "string", "description": "Name of the session" }, "project_name": { "type": "string", "description": "Name of the project the session belongs to" } }, "description": "List of crawl sessions" }, "CrawlSessionsView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "sessions": { "type": "array", "description": "List of crawl sessions", "items": { "$ref": "#/components/schemas/CrawlSessionView" } } } }, "CrawlSuitesView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "suites": { "type": "array", "description": "List of crawl suites", "items": { "$ref": "#/components/schemas/ShortCrawlSuiteView" } } } }, "ShortCrawlSuiteView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "string", "description": "Unique identifier of the crawl suite" }, "identifier": { "type": "string", "description": "Unique identifier for the suite (auto-generated if not provided)" }, "name": { "type": "string", "description": "Name of the crawl suite" }, "full_page": { "type": "boolean", "description": "Whether to capture the full page" }, "color_scheme": { "type": "string", "description": "Color scheme for the crawl", "enum": [ "LIGHT", "DARK", "LIGHT_AND_DARK" ] }, "device_type": { "type": "string", "description": "Device type for the crawl", "enum": [ "EMULATED", "REAL" ] }, "devices": { "type": "array", "description": "List of devices to crawl on", "items": { "$ref": "#/components/schemas/CrawlSuiteDeviceView" } }, "desktop_browsers": { "type": "array", "description": "List of desktop browsers to crawl on", "items": { "type": "string", "description": "List of desktop browsers to crawl on" } }, "desktop_system": { "type": "string", "description": "Desktop system for the crawl", "enum": [ "WINDOWS", "MACOS", "UBUNTU" ] }, "cookies": { "type": "array", "description": "Cookies to set before crawling", "items": { "$ref": "#/components/schemas/CrawlSuiteCookieView" } }, "request_headers": { "type": "array", "description": "Request headers to set before crawling", "items": { "$ref": "#/components/schemas/CrawlSuiteHeaderView" } }, "local_storage": { "type": "array", "description": "Local storage items to set before crawling", "items": { "$ref": "#/components/schemas/CrawlSuiteLocalStorageView" } }, "delays": { "type": "array", "description": "Delays configuration for the crawl", "items": { "$ref": "#/components/schemas/CrawlSuiteDelayView" } }, "wait_for_selectors": { "type": "array", "description": "Selectors to wait for before crawling", "items": { "$ref": "#/components/schemas/CrawlSuiteWaitForSelectorView" } }, "outputs": { "type": "array", "description": "Output configuration for the crawl", "items": { "$ref": "#/components/schemas/CrawlSuiteOutputView" } }, "ignored_urls": { "type": "array", "description": "URLs to ignore during crawling", "items": { "type": "string", "description": "URLs to ignore during crawling" } }, "project_name": { "type": "string", "description": "Name of the project the suite belongs to" }, "concurrents_limit": { "type": "integer", "description": "Maximum number of concurrent crawls", "format": "int32" }, "create_date": { "type": "integer", "description": "Creation date of the suite (Unix timestamp)", "format": "int64" }, "last_update_date": { "type": "integer", "description": "Last update date of the suite (Unix timestamp)", "format": "int64" }, "session_count": { "type": "integer", "description": "Number of sessions in the suite", "format": "int32" }, "crawl_url": { "type": "string", "description": "URL to crawl" }, "follow": { "type": "boolean", "description": "Whether to follow links during crawling" }, "respect_robots": { "type": "boolean", "description": "Whether to respect robots.txt rules" } }, "description": "List of crawl suites" }, "RecordViewIds": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "name": { "type": "string", "description": "The record name (subdomain or @ for root)", "example": "api" }, "type": { "type": "string", "description": "The record type", "example": "A", "enum": [ "SOA", "NS", "A", "AAAA", "CNAME", "ALIAS", "CAA", "SPF", "MX", "TXT", "SRV", "NAPTR", "PTR" ] } }, "description": "Collection of records for the domain" }, "RecordsView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/RecordViewIds" } } } }, "DomainView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "name": { "type": "string", "description": "The name of the domain", "example": "example.com" }, "id": { "type": "string", "description": "The ID of the domain", "example": "4krmDRPw" }, "type": { "type": "string", "description": "The type of the domain", "enum": [ "REGISTERED", "POINTED", "PRIVATE", "CLAIMED" ] }, "pointed_via": { "type": "array", "items": { "type": "string", "description": "Methods used to point this domain (only if `type = POINTED`)", "enum": [ "NS", "CNAME", "DMARC" ] } }, "auto_renew": { "type": "boolean", "description": "Whether the domain is set to auto-renew" }, "transfer_lock": { "type": "boolean", "description": "Whether the domain has transfer lock enabled" }, "dnssec": { "type": "boolean", "description": "Whether DNSSEC is enabled for the domain" }, "expiry_date": { "type": "string", "description": "The expiration date of the domain registration", "format": "date-time" } } }, "RecordView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "name": { "type": "string", "description": "The record name (subdomain or @ for root)", "example": "api" }, "type": { "type": "string", "description": "The record type", "example": "A", "enum": [ "SOA", "NS", "A", "AAAA", "CNAME", "ALIAS", "CAA", "SPF", "MX", "TXT", "SRV", "NAPTR", "PTR" ] }, "values": { "type": "array", "items": { "type": "string", "description": "Values for the record. Different types accept different formats." } }, "ttl": { "type": "integer", "description": "Time To Live in seconds for the DNS record", "format": "int32", "example": 300 }, "routing": { "type": "string", "description": "Routing strategy for the record (simple or geolocation)" }, "country": { "type": "object", "properties": { "country_code": { "type": "array", "items": { "type": "string", "description": "Values for the record. Different types accept different formats." } } }, "description": "Country-specific routing configuration for geolocation records (only used when routing is 'geolocation')", "example": " \"US\": [\"192.168.1.101\", \"192.168.1.102\"],\n \"DE\": [\"192.168.1.103\", \"192.168.1.104\"],\n \"JP\": [\"192.168.1.105\"]\n" }, "continent": { "type": "object", "properties": { "continent": { "type": "array", "items": { "type": "string", "description": "Values for the record. Different types accept different formats." } } }, "description": "Continent-specific routing configuration for geolocation records (only used when routing is 'geolocation')", "example": " \"Europe\": [\"192.168.1.110\", \"192.168.1.111\"],\n \"NorthAmerica\": [\"192.168.1.112\", \"192.168.1.113\"],\n \"Asia\": [\"192.168.1.114\"]\n" } } }, "DomainViewIds": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "name": { "type": "string", "description": "The name of the domain", "example": "example.com" }, "id": { "type": "string", "description": "The ID of the domain", "example": "4krmDRPw" } }, "description": "Collection of domains in the workspace" }, "DomainsView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "domains": { "type": "array", "items": { "$ref": "#/components/schemas/DomainViewIds" } } } }, "PatchRecordCommand": { "required": [ "ttl", "values" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "values": { "type": "array", "description": "New values to set for the DNS record", "items": { "type": "string" } }, "ttl": { "type": "integer", "description": "New TTL value for the DNS record in seconds", "format": "int32" }, "routing": { "type": "string", "description": "Routing strategy: 'simple' (uses only values field) or 'geolocation' (uses country/continent fields, values field is used as default/fallback)", "enum": [ "simple", "geolocation" ] }, "country": { "type": "object", "additionalProperties": { "type": "array", "description": "Country-specific routing values (only used when routing is 'geolocation'). Keys are ISO 3166-1 alpha-2 country codes", "nullable": true, "items": { "type": "string", "description": "Country-specific routing values (only used when routing is 'geolocation'). Keys are ISO 3166-1 alpha-2 country codes", "nullable": true } }, "description": "Country-specific routing values (only used when routing is 'geolocation'). Keys are ISO 3166-1 alpha-2 country codes", "nullable": true }, "continent": { "type": "object", "additionalProperties": { "type": "array", "description": "Continent-specific routing values (only used when routing is 'geolocation'). Available values: Africa, Antarctica, Asia, Europe, NorthAmerica, Oceania, SouthAmerica", "nullable": true, "items": { "type": "string", "description": "Continent-specific routing values (only used when routing is 'geolocation'). Available values: Africa, Antarctica, Asia, Europe, NorthAmerica, Oceania, SouthAmerica", "nullable": true } }, "description": "Continent-specific routing values (only used when routing is 'geolocation'). Available values: Africa, Antarctica, Asia, Europe, NorthAmerica, Oceania, SouthAmerica", "nullable": true } }, "description": "Request to create or update a DNS record" }, "ClaimAvailabilityView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "domain": { "type": "string", "description": "The claimable domain name" }, "available": { "type": "boolean", "description": "Whether the domain is available for claiming" } } }, "ClaimableDomainsView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "domains": { "type": "array", "description": "Collection of claimable domain results", "items": { "$ref": "#/components/schemas/ClaimAvailabilityView" } } } }, "ClaimDomainViewCommand": { "type": "object", "properties": { "name": { "type": "string", "description": "The subdomain to claim under a claimable domain", "example": "food.claim.net" }, "on_owner_behalf": { "type": "boolean", "description": "Whether to claim the domain on the workspace owner's behalf" } } }, "RegisterDomainViewCommand": { "type": "object", "properties": { "name": { "type": "string", "description": "The domain name to register", "example": "example.com" }, "auto_renew": { "type": "boolean", "description": "Whether to enable auto-renewal for the domain" }, "on_owner_behalf": { "type": "boolean", "description": "Whether to register the domain on the workspace owner's behalf" } } }, "DomainAvailabilityPriceView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "name": { "type": "string", "description": "The name of the domain", "example": "example.com" }, "available": { "type": "boolean", "description": "Whether the domain is available for registration" }, "premium": { "type": "boolean", "description": "Whether the domain is a premium domain with higher pricing" }, "prices": { "$ref": "#/components/schemas/DomainPricesView" } } }, "DomainPriceView": { "type": "object", "properties": { "currency": { "type": "string", "description": "The currency of the price" }, "price": { "type": "number", "description": "The price amount", "format": "double" }, "min_duration": { "type": "integer", "description": "Minimum registration duration in years", "format": "int32" }, "max_duration": { "type": "integer", "description": "Maximum registration duration in years", "format": "int32" } }, "description": "Price for restoring an expired domain" }, "DomainPricesView": { "type": "object", "properties": { "create": { "$ref": "#/components/schemas/DomainPriceView" }, "transfer": { "$ref": "#/components/schemas/DomainPriceView" }, "renew": { "$ref": "#/components/schemas/DomainPriceView" }, "restore": { "$ref": "#/components/schemas/DomainPriceView" } }, "description": "Pricing details for domain operations" }, "DomainSearchResultView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "domains": { "type": "array", "description": "Collection of domain availability results", "items": { "$ref": "#/components/schemas/DomainAvailabilityPriceView" } } } }, "DomainSearchCommand": { "type": "object", "properties": { "domains": { "uniqueItems": true, "type": "array", "description": "Set of domain names to check availability for", "items": { "type": "string", "description": "Set of domain names to check availability for" } } } }, "AllowedEnvironmentView": { "required": [ "access_level" ], "type": "object", "properties": { "project": { "type": "string", "description": "A human-readable ID of the project" }, "environment": { "type": "string", "description": "A human-readable ID of the environment" }, "access_level": { "type": "string", "description": "Access level for the allowed environment", "enum": [ "DENIED", "READ_ONLY", "USE_ONLY", "BLIND", "RUN_ONLY", "READ_WRITE", "MANAGE", "DEFAULT", "ALLOWED", "STAGE", "COMMIT", "DENIED", "USE_ONLY" ] } }, "description": "The List of environments that can inherit this environment (specified by project slug and environment slug)" }, "EnvironmentView": { "required": [ "name" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the environment", "format": "int32" }, "name": { "type": "string", "description": "The name of the environment" }, "identifier": { "type": "string", "description": "A human-readable ID of the environment. Alphanumeric characters, underscores, and hyphens (hyphens cannot appear at the start or end)." }, "tags": { "uniqueItems": true, "type": "array", "description": "The list of tags associated with the environment", "items": { "type": "string", "description": "The list of tags associated with the environment" } }, "icon": { "type": "string", "description": "The icon of the environment" }, "public_url": { "type": "string", "description": "The public URL of the environment" }, "pipelines_access_level": { "type": "string", "description": "Indicates if all pipelines can inherit to this environment", "enum": [ "DENIED", "READ_ONLY", "USE_ONLY", "BLIND", "RUN_ONLY", "READ_WRITE", "MANAGE", "DEFAULT", "ALLOWED", "STAGE", "COMMIT" ] }, "environments_access_level": { "type": "string", "description": "Indicates if all pipelines can use this environment", "enum": [ "DENIED", "READ_ONLY", "USE_ONLY", "BLIND", "RUN_ONLY", "READ_WRITE", "MANAGE", "DEFAULT", "ALLOWED", "STAGE", "COMMIT" ] }, "allowed_pipelines": { "type": "array", "description": "The List of pipelines that can use this environment (specified by project slug and pipeline slug)", "items": { "$ref": "#/components/schemas/AllowedPipelineView" } }, "allowed_environments": { "type": "array", "description": "The List of environments that can inherit this environment (specified by project slug and environment slug)", "items": { "$ref": "#/components/schemas/AllowedEnvironmentView" } }, "create_date": { "type": "string", "description": "The creation date of the environment", "format": "date-time" }, "project": { "$ref": "#/components/schemas/ShortProjectView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "base_environments": { "type": "array", "description": "The list of environments that is used as a base for this environment (specified by project slug and environment slug)", "items": { "type": "string", "description": "The list of environments that is used as a base for this environment (specified by project slug and environment slug)" } }, "targets": { "type": "array", "description": "The list of targets associated with the environment", "items": { "$ref": "#/components/schemas/TargetView" } }, "base_only": { "type": "boolean", "description": "Indicates if this environment can only be used as a base for other environments" }, "scope": { "type": "string", "description": "The scope of the environment", "enum": [ "PROJECT", "WORKSPACE", "ANY" ] } } }, "FTPAuthView": { "required": [ "password", "username" ], "type": "object", "properties": { "username": { "type": "string", "description": "The username required to connect to the server" }, "password": { "type": "string", "description": "The password required to connect to the server" } }, "description": "Authentication details" }, "GitAuthView": { "required": [ "method" ], "type": "object", "properties": { "method": { "type": "string", "description": "The authentication for Git", "enum": [ "HTTP", "SSH_KEY", "ASSETS_KEY", "CURRENT" ] }, "username": { "type": "string", "description": "Username required to connect to the Git repository. Required when method is `HTTP`" }, "password": { "type": "string", "description": "Password required to connect to the Git repository. Required when method is `HTTP`" }, "asset": { "type": "string", "description": "Name of the variable containing the private key. Required when method is `ASSETS_KEY`" }, "key": { "type": "string", "description": "The private SSH key. Required when method is `SSH_KEY`" } }, "description": "Authentication details" }, "GroupPermissionView": { "type": "object", "properties": { "id": { "type": "integer", "description": "The ID of the group", "format": "int32" }, "access_level": { "type": "string", "description": "The access level for the group", "enum": [ "DENIED", "READ_ONLY", "USE_ONLY", "BLIND", "RUN_ONLY", "READ_WRITE", "MANAGE", "DEFAULT", "ALLOWED", "STAGE", "COMMIT" ] } } }, "K8sAuthView": { "required": [ "method" ], "type": "object", "properties": { "method": { "type": "string", "description": "Authentication method", "enum": [ "PASS", "CERT", "TOKEN" ] }, "username": { "type": "string", "description": "Username to the Kubernetes cluster. Required if the `auth.method` is `BASIC`" }, "password": { "type": "string", "description": "Password to the Kubernetes cluster. Required if the `auth.method` is `BASIC`" }, "certificate_authority": { "type": "string", "description": "Kuberenetes certificate authority. Required if the `auth.method` is `CERT`" }, "client_certificate": { "type": "string", "description": "Kuberenetes client certificate. Required if the `auth.method` is `CERT`" }, "client_key": { "type": "string", "description": "Kuberenetes client key. Required if the `auth.method` is `CERT`" }, "token": { "type": "string", "description": "Token for the Kubernetes cluster. Required if the `auth.method` is `TOKEN`" } }, "description": "Kubernetes cluster authentication method" }, "MongoAuthView": { "required": [ "password", "username" ], "type": "object", "properties": { "method": { "type": "string", "description": "Authentication method. Default: `PASSWORD`", "enum": [ "PASSWORD" ] }, "username": { "type": "string", "description": "The MongoDB username" }, "password": { "type": "string", "description": "The MongoDB password" } }, "description": "MongoDB authentication credentials" }, "MssqlAuthView": { "required": [ "password", "username" ], "type": "object", "properties": { "method": { "type": "string", "description": "Authentication method. Default: `PASSWORD`", "enum": [ "PASSWORD" ] }, "username": { "type": "string", "description": "The MSSQL username" }, "password": { "type": "string", "description": "The MSSQL password" } }, "description": "MSSQL authentication credentials" }, "MysqlAuthView": { "required": [ "password", "username" ], "type": "object", "properties": { "method": { "type": "string", "description": "Authentication method. Default: `PASSWORD`", "enum": [ "PASSWORD" ] }, "username": { "type": "string", "description": "The MySQL username" }, "password": { "type": "string", "description": "The MySQL password" } }, "description": "MySQL authentication credentials" }, "PermissionsView": { "type": "object", "properties": { "others": { "type": "string", "description": "Access level for other workspace members", "enum": [ "DENIED", "READ_ONLY", "USE_ONLY", "BLIND", "RUN_ONLY", "READ_WRITE", "MANAGE", "DEFAULT", "ALLOWED", "STAGE", "COMMIT" ] }, "users": { "type": "array", "description": "List of specific users with their access levels", "items": { "$ref": "#/components/schemas/UserPermissionView" } }, "groups": { "type": "array", "description": "List of user groups with their access levels", "items": { "$ref": "#/components/schemas/GroupPermissionView" } } }, "description": "Access permissions configuration" }, "PipelineArtifactContextView": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of artifact" }, "scope": { "type": "string", "description": "The scope of the artifact", "enum": [ "WORKSPACE", "PROJECT", "ENVIRONMENT", "ANY" ] } } }, "PipelineEnvironmentContextView": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the environment. Alphanumeric characters, underscores, and hyphens (hyphens cannot appear at the start or end)." }, "tags": { "type": "array", "description": "The list of tags associated with the environment", "items": { "type": "string" } }, "scope": { "type": "string", "description": "The scope of the environment", "enum": [ "PROJECT", "WORKSPACE", "ANY" ] } } }, "PipelineEventView": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of event that triggers the pipeline", "enum": [ "PUSH", "CREATE_REF", "DELETE_REF", "PULL_REQUEST", "SCHEDULE", "PUBLISH_ARTIFACT_VERSION", "DELETE_ARTIFACT_VERSION", "WEBHOOK", "EMAIL", "CREATE_ARTIFACT_VERSION", "ENVIRONMENT_CREATE", "ENVIRONMENT_DELETE", "SANDBOX_CREATED", "SANDBOX_DELETED", "SANDBOX_TIMED_OUT" ] }, "refs": { "type": "array", "description": "The list of refs (branches/tags) that trigger the pipeline for push/ref events", "items": { "type": "string" } }, "events": { "uniqueItems": true, "type": "array", "description": "The list of pull request events that trigger the pipeline. Examples: `OPENED`, `EDITED`, `CLOSED`, `LABELED`, `UNLABELED`, `REVIEW_REQUESTED`, `REVIEW_REQUESTED_REMOVED`, `SYNCHRONIZED`", "items": { "type": "string" } }, "branches": { "type": "array", "description": "The list of branches for pull request events", "items": { "type": "string" } }, "artifacts": { "type": "array", "description": "The list of artifacts that trigger the pipeline", "items": { "$ref": "#/components/schemas/PipelineArtifactContextView" } }, "environments": { "type": "array", "description": "The list of environments that trigger the pipeline", "items": { "$ref": "#/components/schemas/PipelineEnvironmentContextView" } }, "start_date": { "type": "string", "description": "The start date for scheduled events (type `SCHEDULE`)", "format": "date-time" }, "delay": { "type": "integer", "description": "The delay in minutes between scheduled runs (type `SCHEDULE`)", "format": "int64" }, "cron": { "type": "string", "description": "The cron expression for scheduled (type `SCHEDULE`) events e.g., '0 9 * * 1-5' for weekdays at 9 AM" }, "timezone": { "type": "string", "description": "The timezone for scheduled events (type `SCHEDULE`) e.g., 'UTC', 'Europe/Warsaw'" }, "totp": { "type": "boolean", "description": "Whether TOTP (Time-based One-Time Password) is enabled for webhook events (type `WEBHOOK`)" }, "prefix": { "type": "string", "description": "The email subject prefix for email trigger events (type `EMAIL`)" }, "whitelist": { "type": "array", "description": "The list of allowed email addresses that can trigger the pipeline via email (type `EMAIL`)", "items": { "type": "string" } }, "targets": { "type": "array", "description": "The list of sandbox targets that trigger the pipeline for sandbox events (type `SANDBOX_CREATED`, `SANDBOX_DELETED`, `SANDBOX_TIMED_OUT`)", "items": { "$ref": "#/components/schemas/TargetView" } } }, "description": "The list of events that trigger the pipeline run" }, "PipelinePropertyView": { "type": "object", "properties": { "key": { "type": "string", "description": "The key of the pipeline property" }, "value": { "type": "string", "description": "The value of the pipeline property" } }, "description": "The parameters passed to the remote pipeline definition" }, "PostgresqlAuthView": { "required": [ "password", "username" ], "type": "object", "properties": { "method": { "type": "string", "description": "Authentication method. Default: `PASSWORD`", "enum": [ "PASSWORD" ] }, "username": { "type": "string", "description": "The PostgreSQL username" }, "password": { "type": "string", "description": "The PostgreSQL password" } }, "description": "PostgreSQL authentication credentials" }, "SSHAuthView": { "required": [ "method" ], "type": "object", "properties": { "method": { "type": "string", "description": "Authentication method", "enum": [ "PASSWORD", "SSH_KEY", "ASSETS_KEY", "PROXY_CREDENTIALS", "PROXY_KEY" ] }, "username": { "type": "string", "description": "The username required to connect to the server" }, "password": { "type": "string", "description": "The password required to connect to the server. Required for `PASSWORD` method" }, "asset": { "type": "string", "description": "Name of the variable containing the private key. Required for `ASSETS_KEY` method" }, "passphrase": { "type": "string", "description": "Passphrase for the SSH key" }, "key": { "type": "string", "description": "The private SSH key. Required when method is `SSH_KEY`" }, "key_path": { "type": "string", "description": "Path to the key on proxy server. Required for method `PROXY_KEY`" } }, "description": "Define proxy servers' authentication method using the following parameters" }, "ShortPipelineView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The unique ID of the pipeline", "format": "int32" }, "identifier": { "type": "string", "description": "A human-readable ID of pipeline" }, "name": { "type": "string", "description": "The name of the pipeline" }, "definition_source": { "type": "string", "description": "The source of the pipeline definition", "enum": [ "LOCAL", "REMOTE" ] }, "git_config_ref": { "type": "string", "description": "The git configuration reference type", "enum": [ "NONE", "DYNAMIC", "FIXED" ] }, "refs": { "type": "array", "description": "Pipeline git context refs. If unset and events is empty, the pipeline counts as codeless", "items": { "type": "string", "description": "Pipeline git context refs. If unset and events is empty, the pipeline counts as codeless" } }, "events": { "type": "array", "description": "The list of events that trigger the pipeline run", "items": { "$ref": "#/components/schemas/PipelineEventView" } }, "loop": { "uniqueItems": true, "type": "array", "description": "The loop configuration for the pipeline", "items": { "type": "string" } }, "priority": { "type": "string", "description": "The priority of the pipeline", "enum": [ "LOW", "NORMAL", "HIGH" ] }, "disabled": { "type": "boolean", "description": "Indicates if the pipeline is disabled" }, "disabled_reason": { "type": "string", "description": "The reason why the pipeline is disabled" }, "last_execution_status": { "type": "string", "description": "The status of the last run", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "last_execution_revision": { "type": "string", "description": "The git revision of the last run" }, "target_site_url": { "type": "string", "description": "The URL to the target site after deployment" }, "execution_message_template": { "type": "string", "description": "The template for commit status messages" }, "create_date": { "type": "string", "description": "The creation date of the pipeline", "format": "date-time" }, "always_from_scratch": { "type": "boolean", "description": "Defines whether to upload everything from scratch on every run" }, "ignore_fail_on_project_status": { "type": "boolean", "description": "If set to true, the status of a given pipeline will not impact the project status on the dashboard" }, "no_skip_to_most_recent": { "type": "boolean", "description": "If set to true, the pipeline will not skip queued runs to execute the most recent one" }, "terminate_stale_runs": { "type": "boolean", "description": "If set to true, stale runs will be automatically terminated" }, "auto_clear_cache": { "type": "boolean", "description": "Defines whether to automatically clear cache before running the pipeline" }, "paused": { "type": "boolean", "description": "Indicates if the pipeline is paused" }, "pause_on_repeated_failures": { "type": "integer", "description": "Defines how many repeated failures are required to pause the pipeline", "format": "int32" }, "fetch_all_refs": { "type": "boolean", "description": "If set to true, all refs will be fetched from the repository" }, "fetch_lfs": { "type": "boolean", "description": "If set to true, LFS files will be fetched from the external repository during pipeline runs" }, "fail_on_prepare_env_warning": { "type": "boolean", "description": "If set to true, the pipeline will fail on environment preparation warnings" }, "concurrent_pipeline_runs": { "type": "boolean", "description": "Defines whether the pipeline can be run concurrently" }, "clone_depth": { "type": "integer", "description": "Defines the depth of the git clone operation for shallow clones", "format": "int32" }, "do_not_create_commit_status": { "type": "boolean", "description": "If set to true, commit statuses will not be created in the repository" }, "stale": { "type": "boolean", "description": "Indicates that pipeline definition was probably removed on particular Git ref and pipeline won't be run on events" }, "waiting_for_push": { "type": "boolean", "description": "Indicates if the pipeline is waiting for the first push to the repository" }, "resources": { "type": "string", "description": "The resource configuration for the pipeline run", "enum": [ "DEFAULT", "NANO", "SMALL", "MEDIUM", "LARGE", "XLARGE", "CUSTOM", "X2LARGE" ] }, "remote_path": { "type": "string", "description": "The path to the remote pipeline definition file" }, "remote_ref": { "type": "string", "description": "The ref of the remote pipeline definition" }, "remote_project_name": { "type": "string", "description": "The project name of the remote pipeline definition" }, "remote_parameters": { "type": "array", "description": "The parameters passed to the remote pipeline definition", "items": { "$ref": "#/components/schemas/PipelinePropertyView" } }, "git_config": { "$ref": "#/components/schemas/YamlDefinitionView" }, "tags": { "uniqueItems": true, "type": "array", "description": "The list of tags associated with the pipeline for organization", "items": { "type": "string" } }, "git_changeset_base": { "type": "string", "description": "The base for git changeset calculation. Determines which changes trigger the pipeline", "enum": [ "LATEST_RUN", "LATEST_RUN_MATCHING_REF", "PULL_REQUEST" ] }, "filesystem_changeset_base": { "type": "string", "description": "The base for filesystem changeset calculation. Determines which file changes trigger the pipeline", "enum": [ "DATE_MODIFIED", "CONTENTS" ] }, "cpu": { "type": "string", "description": "The CPU architecture for the pipeline run", "enum": [ "X64", "ARM", "X86" ] }, "description_required": { "type": "boolean", "description": "If set to true, a description is required when executing the pipeline manually" }, "folder": { "type": "string", "description": "The folder name where the pipeline is organized" } }, "description": "Short representation of a pipeline" }, "TargetAKSView": { "required": [ "cluster", "identifier", "integration", "resource_group", "subscription" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/TargetView" }, { "type": "object", "properties": { "integration": { "type": "string", "description": "The integration. Required when adding GKE/EKS/AKS/DOKS" }, "cluster": { "type": "string", "description": "The ID of the cluster or fully qualified identifier for the cluster. Required when the platform is set to `GKE`" }, "region": { "type": "string", "description": "EKS region, e.g. `eu-central-1`" }, "proxy": { "$ref": "#/components/schemas/TargetK8sProxyView" }, "subscription": { "type": "string", "description": "Type of AKS subscription" }, "resource_group": { "type": "string", "description": "Azure resource group containing the AKS cluster" } } } ], "x-name": "Azure Kubernetes Service" }, "TargetDOKSView": { "required": [ "cluster", "identifier", "integration" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/TargetView" }, { "type": "object", "properties": { "integration": { "type": "string", "description": "The integration. Required when adding GKE/EKS/AKS/DOKS" }, "cluster": { "type": "string", "description": "The ID of the cluster or fully qualified identifier for the cluster. Required when the platform is set to `GKE`" }, "region": { "type": "string", "description": "EKS region, e.g. `eu-central-1`" }, "proxy": { "$ref": "#/components/schemas/TargetK8sProxyView" } } } ], "x-name": "DigitalOcean Kubernetes" }, "TargetDigitalOceanView": { "required": [ "auth", "host", "identifier", "integration", "port" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/TargetView" }, { "type": "object", "properties": { "host": { "type": "string", "description": "The host for the connection" }, "port": { "type": "string", "description": "The port for the connection" }, "path": { "type": "string", "description": "Path on the server defined in the target" }, "auth": { "$ref": "#/components/schemas/SSHAuthView" }, "proxy": { "$ref": "#/components/schemas/TargetSSHProxyView" }, "integration": { "type": "string", "description": "The integration. Required when adding GKE/EKS/AKS/DOKS" } } } ], "x-name": "DigitalOcean Droplet" }, "TargetEC2View": { "required": [ "auth", "host", "identifier", "integration", "port", "region" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/TargetView" }, { "type": "object", "properties": { "host": { "type": "string", "description": "The host for the connection" }, "port": { "type": "string", "description": "The port for the connection" }, "path": { "type": "string", "description": "Path on the server defined in the target" }, "auth": { "$ref": "#/components/schemas/SSHAuthView" }, "proxy": { "$ref": "#/components/schemas/TargetSSHProxyView" }, "integration": { "type": "string", "description": "The integration. Required when adding GKE/EKS/AKS/DOKS" }, "region": { "type": "string", "description": "EKS region, e.g. `eu-central-1`" } } } ], "x-name": "Amazon EC2" }, "TargetEKSView": { "required": [ "cluster", "identifier", "integration", "region" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/TargetView" }, { "type": "object", "properties": { "integration": { "type": "string", "description": "The integration. Required when adding GKE/EKS/AKS/DOKS" }, "cluster": { "type": "string", "description": "The ID of the cluster or fully qualified identifier for the cluster. Required when the platform is set to `GKE`" }, "region": { "type": "string", "description": "EKS region, e.g. `eu-central-1`" }, "proxy": { "$ref": "#/components/schemas/TargetK8sProxyView" }, "role_arn": { "type": "string", "description": "Amazon resource name specifying the role" } } } ], "x-name": "Amazon Elastic Kubernetes Service" }, "TargetFilterView": { "required": [ "identifier" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/TargetView" }, { "type": "object", "properties": { "scope": { "type": "string", "description": "The scope of the target filter", "enum": [ "WORKSPACE", "PROJECT", "ENVIRONMENT", "PIPELINE", "ACTION", "ANY" ] } } } ], "x-name": "Match" }, "TargetFtpView": { "required": [ "auth", "host", "identifier", "port" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/TargetView" }, { "type": "object", "properties": { "secure": { "type": "boolean", "description": "FTP secure connection (FTPS)" }, "host": { "type": "string", "description": "The host for the connection" }, "port": { "type": "string", "description": "The port for the connection" }, "auth": { "$ref": "#/components/schemas/FTPAuthView" }, "path": { "type": "string", "description": "Path on the server defined in the target" } } } ], "x-name": "FTP Server" }, "TargetGKEView": { "required": [ "cluster", "identifier", "integration", "project_id", "zone" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/TargetView" }, { "type": "object", "properties": { "integration": { "type": "string", "description": "The integration. Required when adding GKE/EKS/AKS/DOKS" }, "cluster": { "type": "string", "description": "The ID of the cluster or fully qualified identifier for the cluster. Required when the platform is set to `GKE`" }, "region": { "type": "string", "description": "EKS region, e.g. `eu-central-1`" }, "proxy": { "$ref": "#/components/schemas/TargetK8sProxyView" }, "zone": { "type": "string", "description": "GKE zone. E.g., `europe-west3-a`" }, "project_id": { "type": "string", "description": "The ID of the Google Cloud project. Required for `GOOGLE_SERVICE_ACCOUNT` integration type with `OIDC` auth_type" } } } ], "x-name": "Google Kubernetes Engine" }, "TargetGitView": { "required": [ "auth", "identifier", "repository" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/TargetView" }, { "type": "object", "properties": { "repository": { "type": "string", "description": "The URL to the Git repository. Required when target type is `GIT`" }, "auth": { "$ref": "#/components/schemas/GitAuthView" } } } ], "x-name": "Git Repository" }, "TargetK8SClusterView": { "required": [ "auth", "cluster", "identifier" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/TargetView" }, { "type": "object", "properties": { "integration": { "type": "string", "description": "The integration. Required when adding GKE/EKS/AKS/DOKS" }, "cluster": { "type": "string", "description": "The ID of the cluster or fully qualified identifier for the cluster. Required when the platform is set to `GKE`" }, "region": { "type": "string", "description": "EKS region, e.g. `eu-central-1`" }, "proxy": { "$ref": "#/components/schemas/TargetK8sProxyView" }, "auth": { "$ref": "#/components/schemas/K8sAuthView" } } } ], "x-name": "Kubernetes Cluster" }, "TargetK8sProxyView": { "type": "object", "properties": { "name": { "type": "string", "description": "Identifier of a target with a tunnel to route K8s API traffic through" } }, "description": "SSH proxy target for tunneling to private MSSQL servers" }, "TargetMongoView": { "required": [ "auth", "host", "identifier" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/TargetView" }, { "type": "object", "properties": { "host": { "type": "string", "description": "The hostname or IP address of the MongoDB server" }, "port": { "type": "string", "description": "The port of the MongoDB server. Default: `27017`" }, "database": { "type": "string", "description": "The default database name" }, "auth_source": { "type": "string", "description": "The authentication database (e.g. `admin`). If not set, the target database is used" }, "auth": { "$ref": "#/components/schemas/MongoAuthView" }, "proxy": { "$ref": "#/components/schemas/TargetK8sProxyView" } } } ], "x-name": "MongoDB" }, "TargetMssqlView": { "required": [ "auth", "host", "identifier" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/TargetView" }, { "type": "object", "properties": { "host": { "type": "string", "description": "The hostname or IP address of the MSSQL server" }, "port": { "type": "string", "description": "The port of the MSSQL server. Default: `1433`" }, "database": { "type": "string", "description": "The default database name" }, "ssl_mode": { "type": "string", "description": "SSL mode: DISABLE (no encryption), REQUIRE (default; encrypted but server certificate is NOT validated, vulnerable to MITM), or VERIFY_FULL (encrypted with full server certificate validation; requires caCertificate)", "enum": [ "DISABLE", "REQUIRE", "VERIFY_FULL" ] }, "ca_certificate": { "type": "string", "description": "PEM-encoded CA certificate (required when sslMode is VERIFY_FULL)" }, "auth": { "$ref": "#/components/schemas/MssqlAuthView" }, "proxy": { "$ref": "#/components/schemas/TargetK8sProxyView" } } } ], "x-name": "Microsoft SQL Server" }, "TargetMysqlView": { "required": [ "auth", "host", "identifier" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/TargetView" }, { "type": "object", "properties": { "host": { "type": "string", "description": "The hostname or IP address of the MySQL server" }, "port": { "type": "string", "description": "The port of the MySQL server. Default: `3306`" }, "database": { "type": "string", "description": "The default database name" }, "auth": { "$ref": "#/components/schemas/MysqlAuthView" }, "proxy": { "$ref": "#/components/schemas/TargetK8sProxyView" } } } ], "x-name": "MySQL" }, "TargetPostgresqlView": { "required": [ "auth", "host", "identifier" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/TargetView" }, { "type": "object", "properties": { "host": { "type": "string", "description": "The hostname or IP address of the PostgreSQL server" }, "port": { "type": "string", "description": "The port of the PostgreSQL server. Default: `5432`" }, "database": { "type": "string", "description": "The default database name" }, "auth": { "$ref": "#/components/schemas/PostgresqlAuthView" }, "proxy": { "$ref": "#/components/schemas/TargetK8sProxyView" } } } ], "x-name": "PostgreSQL" }, "TargetProjectRepoView": { "required": [ "identifier" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/TargetView" } ], "x-name": "Project Repository" }, "TargetRdsMssqlView": { "required": [ "auth", "db_instance_identifier", "host", "identifier", "integration", "region" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/TargetView" }, { "type": "object", "properties": { "region": { "type": "string", "description": "AWS region of the RDS instance, e.g. us-east-1" }, "db_instance_identifier": { "type": "string", "description": "RDS DB instance identifier" }, "integration": { "type": "string", "description": "Hash ID or identifier of an AWS integration" }, "host": { "type": "string", "description": "The hostname or IP address of the MSSQL server" }, "port": { "type": "string", "description": "The port of the MSSQL server. Default: `1433`" }, "database": { "type": "string", "description": "The default database name" }, "ssl_mode": { "type": "string", "description": "SSL mode: DISABLE (no encryption), REQUIRE (default; encrypted but server certificate is NOT validated, vulnerable to MITM), or VERIFY_FULL (encrypted with full server certificate validation; requires caCertificate)", "enum": [ "DISABLE", "REQUIRE", "VERIFY_FULL" ] }, "ca_certificate": { "type": "string", "description": "PEM-encoded CA certificate (required when sslMode is VERIFY_FULL)" }, "auth": { "$ref": "#/components/schemas/MssqlAuthView" }, "proxy": { "$ref": "#/components/schemas/TargetK8sProxyView" } } } ], "x-name": "AWS RDS for SQL Server" }, "TargetSSHProxyView": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the proxy server" }, "host": { "type": "string", "description": "Host for the proxy connection" }, "port": { "type": "string", "description": "The port for the proxy connection" }, "auth": { "$ref": "#/components/schemas/SSHAuthView" } }, "description": "Define a SSH proxy server using the following parameters (available only for SSH targets)" }, "TargetSSHView": { "required": [ "auth", "host", "identifier", "port" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/TargetView" }, { "type": "object", "properties": { "host": { "type": "string", "description": "The host for the connection" }, "port": { "type": "string", "description": "The port for the connection" }, "path": { "type": "string", "description": "Path on the server defined in the target" }, "auth": { "$ref": "#/components/schemas/SSHAuthView" }, "proxy": { "$ref": "#/components/schemas/TargetSSHProxyView" } } } ], "x-name": "SSH Server" }, "TargetUpcloudView": { "required": [ "auth", "host", "identifier", "integration", "port" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/TargetView" }, { "type": "object", "properties": { "host": { "type": "string", "description": "The host for the connection" }, "port": { "type": "string", "description": "The port for the connection" }, "path": { "type": "string", "description": "Path on the server defined in the target" }, "auth": { "$ref": "#/components/schemas/SSHAuthView" }, "proxy": { "$ref": "#/components/schemas/TargetSSHProxyView" }, "integration": { "type": "string", "description": "The integration. Required when adding GKE/EKS/AKS/DOKS" } } } ], "x-name": "UpCloud Server" }, "TargetView": { "required": [ "identifier" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "string", "description": "The ID of the target" }, "identifier": { "type": "string", "description": "A human-readable ID. Alphanumeric characters, underscores, and hyphens (hyphens cannot appear at the start or end)." }, "name": { "type": "string", "description": "The name of the target" }, "project": { "$ref": "#/components/schemas/ShortProjectView" }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "environment": { "$ref": "#/components/schemas/ShortEnvironmentView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "pipelines_access_level": { "type": "string", "description": "Pipelines access level for this target", "enum": [ "DENIED", "READ_ONLY", "USE_ONLY", "BLIND", "RUN_ONLY", "READ_WRITE", "MANAGE", "DEFAULT", "ALLOWED", "STAGE", "COMMIT" ] }, "allowed_pipelines": { "type": "array", "description": "List of specific pipelines allowed to use this target", "items": { "$ref": "#/components/schemas/AllowedPipelineView" } }, "sandboxes_access_level": { "type": "string", "description": "Sandboxes access level for this target", "enum": [ "DENIED", "READ_ONLY", "USE_ONLY", "BLIND", "RUN_ONLY", "READ_WRITE", "MANAGE", "DEFAULT", "ALLOWED", "STAGE", "COMMIT" ] }, "allowed_sandboxes": { "type": "array", "description": "List of specific sandboxes allowed to use this target", "items": { "$ref": "#/components/schemas/AllowedSandboxView" } }, "disabled": { "type": "boolean", "description": "Indicates if this target is disabled (default: `false`)" }, "tags": { "uniqueItems": true, "type": "array", "description": "The list of tags associated with the target", "items": { "type": "string" } }, "use_as": { "$ref": "#/components/schemas/UseAsView" }, "type": { "type": "string", "description": "The type of the target", "enum": [ "SSH", "FTP", "GIT", "MATCH", "EC2", "DIGITAL_OCEAN", "VULTR", "UPCLOUD", "GKE", "EKS", "AKS", "DOKS", "K8S_CLUSTER", "MYSQL", "POSTGRESQL", "PROJECT_REPO", "MONGO", "MSSQL", "RDS_MSSQL" ] } }, "discriminator": { "propertyName": "type", "mapping": { "SSH": "#/components/schemas/TargetSSHView", "FTP": "#/components/schemas/TargetFtpView", "MATCH": "#/components/schemas/TargetFilterView", "VULTR": "#/components/schemas/TargetVultrView", "DIGITAL_OCEAN": "#/components/schemas/TargetDigitalOceanView", "UPCLOUD": "#/components/schemas/TargetUpcloudView", "GIT": "#/components/schemas/TargetGitView", "GKE": "#/components/schemas/TargetGKEView", "DOKS": "#/components/schemas/TargetDOKSView", "AKS": "#/components/schemas/TargetAKSView", "EKS": "#/components/schemas/TargetEKSView", "K8S_CLUSTER": "#/components/schemas/TargetK8SClusterView", "EC2": "#/components/schemas/TargetEC2View", "MYSQL": "#/components/schemas/TargetMysqlView", "POSTGRESQL": "#/components/schemas/TargetPostgresqlView", "MONGO": "#/components/schemas/TargetMongoView", "MSSQL": "#/components/schemas/TargetMssqlView", "RDS_MSSQL": "#/components/schemas/TargetRdsMssqlView", "PROJECT_REPO": "#/components/schemas/TargetProjectRepoView" } }, "oneOf": [ { "$ref": "#/components/schemas/TargetSSHView" }, { "$ref": "#/components/schemas/TargetFtpView" }, { "$ref": "#/components/schemas/TargetFilterView" }, { "$ref": "#/components/schemas/TargetVultrView" }, { "$ref": "#/components/schemas/TargetDigitalOceanView" }, { "$ref": "#/components/schemas/TargetUpcloudView" }, { "$ref": "#/components/schemas/TargetGitView" }, { "$ref": "#/components/schemas/TargetGKEView" }, { "$ref": "#/components/schemas/TargetDOKSView" }, { "$ref": "#/components/schemas/TargetAKSView" }, { "$ref": "#/components/schemas/TargetEKSView" }, { "$ref": "#/components/schemas/TargetK8SClusterView" }, { "$ref": "#/components/schemas/TargetEC2View" }, { "$ref": "#/components/schemas/TargetMysqlView" }, { "$ref": "#/components/schemas/TargetPostgresqlView" }, { "$ref": "#/components/schemas/TargetMongoView" }, { "$ref": "#/components/schemas/TargetMssqlView" }, { "$ref": "#/components/schemas/TargetRdsMssqlView" }, { "$ref": "#/components/schemas/TargetProjectRepoView" } ] }, "TargetVultrView": { "required": [ "auth", "host", "identifier", "integration", "port" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/TargetView" }, { "type": "object", "properties": { "host": { "type": "string", "description": "The host for the connection" }, "port": { "type": "string", "description": "The port for the connection" }, "path": { "type": "string", "description": "Path on the server defined in the target" }, "auth": { "$ref": "#/components/schemas/SSHAuthView" }, "proxy": { "$ref": "#/components/schemas/TargetSSHProxyView" }, "integration": { "type": "string", "description": "The integration. Required when adding GKE/EKS/AKS/DOKS" } } } ], "x-name": "Vultr Server" }, "UseAsView": { "type": "object", "properties": { "target": { "type": "boolean", "description": "Whether the target can be used as a deployment target (default: `true`)" }, "proxy": { "type": "boolean", "description": "Whether the target can be used as a proxy (default: `true`)" } }, "description": "Defines how the target can be used (as deployment target, proxy, or both)" }, "UserPermissionView": { "type": "object", "properties": { "id": { "type": "integer", "description": "The ID of the user", "format": "int32" }, "access_level": { "type": "string", "description": "The access level for the user", "enum": [ "DENIED", "READ_ONLY", "USE_ONLY", "BLIND", "RUN_ONLY", "READ_WRITE", "MANAGE", "DEFAULT", "ALLOWED", "STAGE", "COMMIT" ] } } }, "YamlDefinitionView": { "type": "object", "properties": { "path": { "type": "string", "description": "The file path to the YAML definition" }, "branch": { "type": "string", "description": "The git ref (branch/tag) where the YAML definition is located" }, "project": { "type": "string", "description": "The project name where the YAML definition is located" } }, "description": "YAML pipeline definition configuration" }, "AllowedEnvironmentRequest": { "required": [ "access_level" ], "type": "object", "properties": { "project": { "type": "string", "description": "A human-readable ID of the project" }, "environment": { "type": "string", "description": "A human-readable ID of the environment" }, "access_level": { "type": "string", "description": "Access level for the allowed environment", "enum": [ "DENIED", "READ_ONLY", "USE_ONLY", "BLIND", "RUN_ONLY", "READ_WRITE", "MANAGE", "DEFAULT", "ALLOWED", "STAGE", "COMMIT", "DENIED", "USE_ONLY" ] } }, "description": "The List of environments that can inherit this environment (specified by project slug and environment slug)" }, "AllowedPipelineRequest": { "type": "object", "properties": { "project": { "type": "string", "description": "A human-readable ID of the project" }, "pipeline": { "type": "string", "description": "A human-readable ID of the pipeline" }, "access_level": { "type": "string", "description": "Access level for the allowed pipeline", "enum": [ "DENIED", "READ_ONLY", "USE_ONLY", "BLIND", "RUN_ONLY", "READ_WRITE", "MANAGE", "DEFAULT", "ALLOWED", "STAGE", "COMMIT" ] } }, "description": "The List of pipelines that can use this environment (specified by project slug and pipeline slug)" }, "EnvironmentRequest": { "required": [ "identifier", "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "The name of the environment" }, "identifier": { "type": "string", "description": "A human-readable ID of the environment. Alphanumeric characters, underscores, and hyphens (hyphens cannot appear at the start or end)." }, "tags": { "uniqueItems": true, "type": "array", "description": "The list of tags associated with the environment", "items": { "type": "string", "description": "The list of tags associated with the environment" } }, "icon": { "type": "string", "description": "The icon of the environment" }, "public_url": { "type": "string", "description": "The public URL of the environment" }, "pipelines_access_level": { "type": "string", "description": "Indicates if all pipelines can inherit to this environment", "enum": [ "DENIED", "READ_ONLY", "USE_ONLY", "BLIND", "RUN_ONLY", "READ_WRITE", "MANAGE", "DEFAULT", "ALLOWED", "STAGE", "COMMIT" ] }, "environments_access_level": { "type": "string", "description": "Indicates if all pipelines can use this environment", "enum": [ "DENIED", "READ_ONLY", "USE_ONLY", "BLIND", "RUN_ONLY", "READ_WRITE", "MANAGE", "DEFAULT", "ALLOWED", "STAGE", "COMMIT" ] }, "allowed_pipelines": { "type": "array", "description": "The List of pipelines that can use this environment (specified by project slug and pipeline slug)", "items": { "$ref": "#/components/schemas/AllowedPipelineRequest" } }, "allowed_environments": { "type": "array", "description": "The List of environments that can inherit this environment (specified by project slug and environment slug)", "items": { "$ref": "#/components/schemas/AllowedEnvironmentRequest" } }, "project": { "$ref": "#/components/schemas/ProjectReference" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "base_environments": { "type": "array", "description": "The list of environments that is used as a base for this environment (specified by project slug and environment slug)", "items": { "type": "string", "description": "The list of environments that is used as a base for this environment (specified by project slug and environment slug)" } }, "base_only": { "type": "boolean", "description": "Indicates if this environment can only be used as a base for other environments" }, "scope": { "type": "string", "description": "The scope of the environment", "enum": [ "PROJECT", "WORKSPACE", "ANY" ] } } }, "ProjectReference": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "The project to which the environment is assigned (specified by project slug)" } }, "description": "The project to which the environment is assigned (specified by project slug)" }, "GroupView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the group", "format": "int32" }, "name": { "type": "string", "description": "The name of the group" }, "description": { "type": "string", "description": "The description of the group" }, "auto_assign_to_new_projects": { "type": "boolean", "description": "Whether to automatically assign group members to new projects" }, "allow_add_new_projects": { "type": "boolean", "description": "Whether group members are allowed to add new projects" }, "allow_add_new_domains_on_owner_behalf": { "type": "boolean", "description": "Whether group members are allowed to buy new domains on behalf of the workspace owner" }, "auto_assign_permission_set_id": { "type": "integer", "description": "The ID of the permission set to automatically assign to new project members", "format": "int32" } } }, "AddGroupRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "The name of the group" }, "description": { "type": "string", "description": "The description of the group" }, "auto_assign_to_new_projects": { "type": "boolean", "description": "Whether to automatically assign group members to new projects" }, "allow_add_new_projects": { "type": "boolean", "description": "Whether group members are allowed to add new projects" }, "allow_add_new_domains_on_owner_behalf": { "type": "boolean", "description": "Whether group members are allowed to buy new domains on behalf of the workspace owner" }, "auto_assign_permission_set_id": { "type": "integer", "description": "The ID of the permission set to automatically assign to new project members", "format": "int32" } } }, "GroupMemberView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the user", "format": "int32" }, "name": { "type": "string", "description": "The name of the user" }, "avatar_url": { "type": "string", "description": "The avatar URL of the user" }, "email": { "type": "string", "description": "The email address of the user" }, "admin": { "type": "boolean", "description": "Whether the user has admin privileges" }, "workspace_owner": { "type": "boolean", "description": "Whether the user is workspace owner" }, "status": { "type": "string", "description": "The status of the group member", "enum": [ "MEMBER", "MANAGER" ] } } }, "AddGroupMemberRequest": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "description": "The ID of the user", "format": "int32" }, "status": { "type": "string", "description": "The status of the group member", "enum": [ "MEMBER", "MANAGER" ] } } }, "GroupMembersView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "members": { "type": "array", "items": { "$ref": "#/components/schemas/GroupMemberView" } } } }, "GroupsView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/ShortGroupView" } } } }, "ShortGroupView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the group", "format": "int32" }, "name": { "type": "string", "description": "The name of the group" }, "description": { "type": "string", "description": "The description of the group" } } }, "UpdateGroupRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the group" }, "description": { "type": "string", "description": "The description of the group" }, "auto_assign_to_new_projects": { "type": "boolean", "description": "Whether to automatically assign group members to new projects" }, "allow_add_new_projects": { "type": "boolean", "description": "Whether group members are allowed to add new projects" }, "allow_add_new_domains_on_owner_behalf": { "type": "boolean", "description": "Whether group members are allowed to buy new domains on behalf of the workspace owner" }, "auto_assign_permission_set_id": { "type": "integer", "description": "The ID of the permission set to automatically assign to new project members", "format": "int32" } } }, "UpdateGroupMemberRequest": { "type": "object", "properties": { "status": { "type": "string", "description": "The status of the group member", "enum": [ "MEMBER", "MANAGER" ] } } }, "ShortTestCaseView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "string", "description": "Unique identifier of the test case" }, "name": { "type": "string", "description": "Name of the test case" }, "test_group_name": { "type": "string", "description": "Name of the test group this case belongs to (typically corresponds to a test suite in JUnit XML)" }, "test_group_id": { "type": "string", "description": "ID of the test group this case belongs to" }, "classname": { "type": "string", "description": "Fully qualified class name of the test" }, "status": { "type": "string", "description": "Test execution status", "enum": [ "PASSED", "FAILED", "SKIPPED", "ERROR" ] }, "time": { "type": "number", "description": "Execution time in seconds", "format": "double" } } }, "TestCasesView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "cases": { "type": "array", "items": { "$ref": "#/components/schemas/ShortTestCaseView" } } } }, "AddCasesRequest": { "required": [ "cases" ], "type": "object", "properties": { "cases": { "type": "array", "items": { "$ref": "#/components/schemas/AddTestCaseRequest" } } } }, "AddTestCaseRequest": { "required": [ "classname", "name", "status", "test_group_name", "time" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the test case" }, "test_group_name": { "type": "string", "description": "Name of the test group this case belongs to (typically corresponds to a test suite in JUnit XML)" }, "classname": { "type": "string", "description": "Fully qualified class name of the test" }, "status": { "type": "string", "description": "Test execution status", "enum": [ "PASSED", "FAILED", "SKIPPED", "ERROR" ] }, "time": { "type": "number", "description": "Execution time in seconds", "format": "double" }, "data": { "type": "string", "description": "Original XML data from the test report" } } }, "MemberView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the user", "format": "int32" }, "name": { "type": "string", "description": "The name of the user" }, "avatar_url": { "type": "string", "description": "The avatar URL of the user" }, "email": { "type": "string", "description": "The email address of the user" }, "admin": { "type": "boolean", "description": "Whether the user has admin privileges" }, "workspace_owner": { "type": "boolean", "description": "Whether the user is workspace owner" } }, "description": "User/member reference" }, "TestSessionView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "Unique identifier of the test session", "format": "int32" }, "relative_id": { "type": "integer", "description": "Sequential ID within the suite", "format": "int32" }, "create_date": { "type": "string", "description": "Timestamp when the session was created", "format": "date-time" }, "start_date": { "type": "string", "description": "Timestamp when the session started", "format": "date-time" }, "finish_date": { "type": "string", "description": "Timestamp when the session finished", "format": "date-time" }, "created_by": { "$ref": "#/components/schemas/MemberView" }, "ci_provider": { "type": "string", "description": "CI provider that initiated the test session", "enum": [ "NONE", "BUDDY", "GITHUB_ACTION", "CIRCLE_CI" ] }, "ci_run_url": { "type": "string", "description": "URL to the external CI/CD run" }, "revision": { "type": "string", "description": "Ending revision/commit hash for the test range" }, "ref_type": { "type": "string", "description": "Type of Git reference", "enum": [ "BRANCH", "TAG", "PULL_REQUEST" ] }, "ref_name": { "type": "string", "description": "Name of the Git reference (branch name, tag name, etc.). May be null if ref_type is not provided." }, "execution_id": { "type": "string", "description": "Execution hash ID. Set when session is a result of BUDDY action execution" }, "action_execution_id": { "type": "string", "description": "Action execution hash ID. Set when session is a result of BUDDY action execution" }, "status": { "type": "string", "description": "Current status of the session", "enum": [ "IN_PROGRESS", "SUCCESSFUL", "ERROR", "SKIPPED" ] }, "error_message": { "type": "string", "description": "Error message if the session failed. Set when status is ERROR." }, "duration": { "type": "integer", "description": "Total duration in seconds", "format": "int32" }, "tests_count": { "type": "integer", "description": "Total number of tests", "format": "int32" }, "failed_count": { "type": "integer", "description": "Number of failed tests", "format": "int32" }, "skipped_count": { "type": "integer", "description": "Number of skipped tests", "format": "int32" }, "error_count": { "type": "integer", "description": "Number of tests with errors", "format": "int32" } } }, "AddSessionRequest": { "type": "object", "properties": { "ci_provider": { "type": "string", "description": "CI provider that initiated the test session", "enum": [ "NONE", "BUDDY", "GITHUB_ACTION", "CIRCLE_CI" ] }, "ci_run_url": { "type": "string", "description": "URL to the external CI/CD run" }, "revision": { "type": "string", "description": "Ending revision/commit hash for the test range" }, "ref_type": { "type": "string", "description": "Type of Git reference", "enum": [ "BRANCH", "TAG", "PULL_REQUEST" ] }, "ref_name": { "type": "string", "description": "Name of the Git reference (branch name, tag name, etc.). May be null if ref_type is not provided." }, "run_id": { "type": "string", "description": "External CI/CD run identifier (e.g., GitHub Actions run ID)" }, "created_by": { "$ref": "#/components/schemas/MemberIdRequest" }, "execution_id": { "type": "string", "description": "Execution hash ID. Set when session is a result of BUDDY action execution" }, "action_execution_id": { "type": "string", "description": "Action execution hash ID. Set when session is a result of BUDDY action execution" } } }, "MemberIdRequest": { "type": "object", "properties": { "id": { "type": "integer", "description": "The ID of the user", "format": "int32" } }, "description": "User/member reference" }, "ActivationDataFlavor": { "type": "object", "properties": { "mime_type": { "type": "string" }, "human_presentable_name": { "type": "string" } } }, "Attachment": { "type": "object", "properties": { "headers": { "type": "object", "properties": { "empty": { "type": "boolean" } }, "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "object": { "type": "object" }, "content_id": { "type": "string" }, "data_handler": { "$ref": "#/components/schemas/DataHandler" }, "content_disposition": { "$ref": "#/components/schemas/ContentDisposition" }, "content_type": { "$ref": "#/components/schemas/MediaType" } } }, "CommandInfo": { "type": "object", "properties": { "command_name": { "type": "string" }, "command_class": { "type": "string" } } }, "CommandMap": { "type": "object", "properties": { "mime_types": { "type": "array", "items": { "type": "string" } } } }, "ContentDisposition": { "type": "object", "properties": { "type": { "type": "string" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" } }, "filename": { "type": "string" } } }, "DataHandler": { "type": "object", "properties": { "data_source": { "$ref": "#/components/schemas/DataSource" }, "name": { "type": "string" }, "input_stream": { "type": "object" }, "content": { "type": "object" }, "commandMap": { "$ref": "#/components/schemas/CommandMap" }, "transfer_data_flavors": { "type": "array", "items": { "$ref": "#/components/schemas/ActivationDataFlavor" } }, "preferred_commands": { "type": "array", "items": { "$ref": "#/components/schemas/CommandInfo" } }, "all_commands": { "type": "array", "items": { "$ref": "#/components/schemas/CommandInfo" } }, "content_type": { "type": "string" }, "output_stream": { "type": "object" } } }, "DataSource": { "type": "object", "properties": { "name": { "type": "string" }, "input_stream": { "type": "object" }, "content_type": { "type": "string" }, "output_stream": { "type": "object" } } }, "ImportSessionRequest": { "required": [ "files" ], "type": "object", "properties": { "files": { "type": "array", "description": "JUnit XML report file(s). You can upload multiple files by using the same field name multiple times.", "format": "binary", "items": { "$ref": "#/components/schemas/Attachment" } }, "ci_provider": { "type": "string", "description": "CI provider that initiated the test session", "enum": [ "NONE", "BUDDY", "GITHUB_ACTION", "CIRCLE_CI" ] }, "ci_run_url": { "type": "string", "description": "URL to the external CI/CD run" }, "revision": { "type": "string", "description": "Ending revision/commit hash for the test range" }, "ref_type": { "type": "string", "description": "Type of Git reference", "enum": [ "BRANCH", "TAG", "PULL_REQUEST" ] }, "ref_name": { "type": "string", "description": "Name of the Git reference (branch name, tag name, etc.). May be null if ref_type is not provided." }, "execution_id": { "type": "string", "description": "Execution hash ID. Set when session is a result of BUDDY action execution" }, "action_execution_id": { "type": "string", "description": "Action execution hash ID. Set when session is a result of BUDDY action execution" } }, "description": "Multipart request for importing test session from JUnit XML file(s)" }, "MediaType": { "type": "object", "properties": { "type": { "type": "string" }, "subtype": { "type": "string" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" } }, "wildcard_type": { "type": "boolean" }, "wildcard_subtype": { "type": "boolean" } } }, "TestCaseView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "string", "description": "Unique identifier of the test case" }, "name": { "type": "string", "description": "Name of the test case" }, "test_group_name": { "type": "string", "description": "Name of the test group this case belongs to (typically corresponds to a test suite in JUnit XML)" }, "test_group_id": { "type": "string", "description": "ID of the test group this case belongs to" }, "classname": { "type": "string", "description": "Fully qualified class name of the test" }, "status": { "type": "string", "description": "Test execution status", "enum": [ "PASSED", "FAILED", "SKIPPED", "ERROR" ] }, "time": { "type": "number", "description": "Execution time in seconds", "format": "double" }, "data": { "type": "string", "description": "Original XML data from the test report" } } }, "TestGroupView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "string", "description": "Unique identifier of the test group" }, "name": { "type": "string", "description": "Name of the test group (typically corresponds to a test suite in JUnit XML)" }, "time": { "type": "number", "description": "Total execution time in seconds", "format": "double" }, "tests_count": { "type": "integer", "description": "Total number of tests in the group", "format": "int32" }, "failed_count": { "type": "integer", "description": "Number of failed tests in the group", "format": "int32" }, "skipped_count": { "type": "integer", "description": "Number of skipped tests in the group", "format": "int32" }, "error_count": { "type": "integer", "description": "Number of tests with errors in the group", "format": "int32" }, "status": { "type": "string", "description": "Overall status of the test group", "enum": [ "PASSED", "FAILED", "SKIPPED", "ERROR" ] } } }, "AddTestGroupRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the test group (typically corresponds to a test suite in JUnit XML)" } } }, "UnitTestSuiteView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "Unique identifier of the test suite", "format": "int32" }, "name": { "type": "string", "description": "Name of the unit test suite" }, "identifier": { "type": "string", "description": "Unique identifier for the suite (auto-generated if not provided)" }, "timeout": { "type": "integer", "description": "Timeout in seconds for test execution", "format": "int32" }, "error_pattern": { "type": "string", "description": "Markdown template for formatting test case error results (max 1024 characters)" }, "token": { "type": "string", "description": "Authentication token for the suite" }, "slow_threshold": { "type": "integer", "description": "Threshold in milliseconds to mark tests as slow", "format": "int32" }, "send_commit_status": { "type": "boolean", "description": "Whether to send commit status to the external repository for test results" } } }, "AddSuiteRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the unit test suite" }, "identifier": { "type": "string", "description": "Unique identifier for the suite (auto-generated if not provided)" }, "timeout": { "type": "integer", "description": "Timeout in seconds for test execution", "format": "int32" }, "error_pattern": { "type": "string", "description": "Markdown template for formatting test case error results (max 1024 characters)" }, "slow_threshold": { "type": "integer", "description": "Threshold in milliseconds to mark tests as slow", "format": "int32" }, "send_commit_status": { "type": "boolean", "description": "Whether to send commit status to the external repository for test results" } } }, "TestGroupsView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "test_groups": { "type": "array", "items": { "$ref": "#/components/schemas/TestGroupView" } } } }, "TestSessionsView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "sessions": { "type": "array", "items": { "$ref": "#/components/schemas/TestSessionView" } } } }, "ShortUnitTestSuiteView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "Unique identifier of the test suite", "format": "int32" }, "name": { "type": "string", "description": "Name of the unit test suite" }, "identifier": { "type": "string", "description": "Unique identifier for the suite (auto-generated if not provided)" } } }, "UnitTestSuitesView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "suites": { "type": "array", "items": { "$ref": "#/components/schemas/ShortUnitTestSuiteView" } } } }, "DynamicClientRegistrationResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "client_id": { "type": "string" }, "client_secret": { "type": "string" }, "registration_access_token": { "type": "string" }, "registration_client_uri": { "type": "string" }, "client_id_issued_at": { "type": "integer", "format": "int64" }, "client_secret_expires_at": { "type": "integer", "format": "int64" }, "client_name": { "type": "string" }, "redirect_uris": { "type": "array", "items": { "type": "string" } }, "grant_types": { "type": "array", "items": { "type": "string" } }, "response_types": { "type": "array", "items": { "type": "string" } }, "token_endpoint_auth_method": { "type": "string" }, "client_uri": { "type": "string" }, "logo_uri": { "type": "string" }, "scope": { "type": "string" }, "contacts": { "type": "array", "items": { "type": "string" } }, "tos_uri": { "type": "string" }, "policy_uri": { "type": "string" }, "jwks_uri": { "type": "string" }, "software_id": { "type": "string" }, "software_version": { "type": "string" }, "application_type": { "type": "string" }, "sector_identifier_uri": { "type": "string" }, "subject_type": { "type": "string" }, "id_token_signed_response_alg": { "type": "string" }, "userinfo_signed_response_alg": { "type": "string" }, "request_object_signing_alg": { "type": "string" }, "description": { "type": "string" }, "token_expires_in": { "type": "integer", "format": "int32" } } }, "DynamicClientRegistrationRequest": { "type": "object", "properties": { "valid": { "type": "boolean" }, "primary_redirect_uri": { "type": "string" }, "client_name": { "maxLength": 255, "minLength": 0, "type": "string" }, "redirect_uris": { "type": "array", "items": { "type": "string" } }, "grant_types": { "type": "array", "items": { "type": "string" } }, "response_types": { "type": "array", "items": { "type": "string" } }, "token_endpoint_auth_method": { "type": "string" }, "client_uri": { "type": "string" }, "logo_uri": { "type": "string" }, "scope": { "type": "string" }, "contacts": { "type": "array", "items": { "type": "string" } }, "tos_uri": { "type": "string" }, "policy_uri": { "type": "string" }, "jwks_uri": { "type": "string" }, "software_id": { "type": "string" }, "software_version": { "type": "string" }, "application_type": { "type": "string" }, "sector_identifier_uri": { "type": "string" }, "subject_type": { "type": "string" }, "id_token_signed_response_alg": { "type": "string" }, "userinfo_signed_response_alg": { "type": "string" }, "request_object_signing_alg": { "type": "string" }, "description": { "maxLength": 255, "minLength": 0, "type": "string" } } }, "TokenFront": { "type": "object", "properties": { "access_token": { "type": "string", "description": "The access token issued by the authorization server" }, "token_type": { "type": "string", "description": "The type of the token issued", "example": "Bearer" }, "expires_in": { "type": "integer", "description": "The lifetime in seconds of the access token", "format": "int32" }, "refresh_token": { "type": "string", "description": "The refresh token, which can be used to obtain new access tokens" }, "refresh_token_expires_in": { "type": "integer", "description": "The lifetime in seconds of the refresh token", "format": "int32" } } }, "IssueTokenRequest": { "required": [ "provider_id", "web_identity_token" ], "type": "object", "properties": { "provider_id": { "type": "string", "description": "The ID of the OIDC provider" }, "web_identity_token": { "type": "string", "description": "The Web Identity Token from the OIDC provider" } } }, "PermissionSetView": { "required": [ "artifact_access_level", "environment_access_level", "id", "name", "pipeline_access_level", "project_team_access_level", "repository_access_level", "routing_access_level", "sandbox_access_level", "target_access_level", "tunnel_agent_access_level" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "name": { "type": "string", "description": "The name of the permission set" }, "description": { "type": "string", "description": "The description of the permission set" }, "repository_access_level": { "type": "string", "description": "The repository access level", "enum": [ "DENIED", "READ_ONLY", "READ_WRITE", "MANAGE" ] }, "pipeline_access_level": { "type": "string", "description": "The pipeline access level", "enum": [ "DENIED", "READ_ONLY", "RUN_ONLY", "READ_WRITE" ] }, "sandbox_access_level": { "type": "string", "description": "The sandbox access level", "enum": [ "DENIED", "READ_ONLY", "RUN_ONLY", "READ_WRITE" ] }, "project_team_access_level": { "type": "string", "description": "The project team access level", "enum": [ "READ_ONLY", "MANAGE" ] }, "environment_access_level": { "type": "string", "description": "The environment access level", "enum": [ "DENIED", "MANAGE", "USE_ONLY" ] }, "artifact_access_level": { "type": "string", "description": "The artifact access level", "enum": [ "DENIED", "READ_ONLY", "READ_WRITE", "MANAGE" ] }, "routing_access_level": { "type": "string", "description": "The routing access level", "enum": [ "DENIED", "READ_ONLY", "MANAGE" ] }, "target_access_level": { "type": "string", "description": "The target access level", "enum": [ "DENIED", "READ_ONLY", "USE_ONLY", "MANAGE" ] }, "tunnel_agent_access_level": { "type": "string", "description": "Tunnel agent access level", "enum": [ "DENIED", "READ_ONLY", "USE_ONLY", "MANAGE" ] }, "id": { "type": "integer", "description": "The ID of the permission set", "format": "int32" }, "type": { "type": "string", "description": "The type of the permission set", "enum": [ "DEVELOPER", "READ_ONLY", "CUSTOM", "PROJECT_MANAGER" ] } }, "description": "User permission set configuration" }, "AddPermissionSetRequest": { "required": [ "artifact_access_level", "environment_access_level", "name", "pipeline_access_level", "project_team_access_level", "repository_access_level", "routing_access_level", "sandbox_access_level", "target_access_level", "tunnel_agent_access_level" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "name": { "type": "string", "description": "The name of the permission set" }, "description": { "type": "string", "description": "The description of the permission set" }, "repository_access_level": { "type": "string", "description": "The repository access level", "enum": [ "DENIED", "READ_ONLY", "READ_WRITE", "MANAGE" ] }, "pipeline_access_level": { "type": "string", "description": "The pipeline access level", "enum": [ "DENIED", "READ_ONLY", "RUN_ONLY", "READ_WRITE" ] }, "sandbox_access_level": { "type": "string", "description": "The sandbox access level", "enum": [ "DENIED", "READ_ONLY", "RUN_ONLY", "READ_WRITE" ] }, "project_team_access_level": { "type": "string", "description": "The project team access level", "enum": [ "READ_ONLY", "MANAGE" ] }, "environment_access_level": { "type": "string", "description": "The environment access level", "enum": [ "DENIED", "MANAGE", "USE_ONLY" ] }, "artifact_access_level": { "type": "string", "description": "The artifact access level", "enum": [ "DENIED", "READ_ONLY", "READ_WRITE", "MANAGE" ] }, "routing_access_level": { "type": "string", "description": "The routing access level", "enum": [ "DENIED", "READ_ONLY", "MANAGE" ] }, "target_access_level": { "type": "string", "description": "The target access level", "enum": [ "DENIED", "READ_ONLY", "USE_ONLY", "MANAGE" ] }, "tunnel_agent_access_level": { "type": "string", "description": "Tunnel agent access level", "enum": [ "DENIED", "READ_ONLY", "USE_ONLY", "MANAGE" ] } } }, "PermissionSetsView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "permission_sets": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionSetView" } } } }, "UpdatePermissionSetRequest": { "required": [ "artifact_access_level", "environment_access_level", "name", "pipeline_access_level", "project_team_access_level", "repository_access_level", "routing_access_level", "sandbox_access_level", "target_access_level", "tunnel_agent_access_level" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "name": { "type": "string", "description": "The name of the permission set" }, "description": { "type": "string", "description": "The description of the permission set" }, "repository_access_level": { "type": "string", "description": "The repository access level", "enum": [ "DENIED", "READ_ONLY", "READ_WRITE", "MANAGE" ] }, "pipeline_access_level": { "type": "string", "description": "The pipeline access level", "enum": [ "DENIED", "READ_ONLY", "RUN_ONLY", "READ_WRITE" ] }, "sandbox_access_level": { "type": "string", "description": "The sandbox access level", "enum": [ "DENIED", "READ_ONLY", "RUN_ONLY", "READ_WRITE" ] }, "project_team_access_level": { "type": "string", "description": "The project team access level", "enum": [ "READ_ONLY", "MANAGE" ] }, "environment_access_level": { "type": "string", "description": "The environment access level", "enum": [ "DENIED", "MANAGE", "USE_ONLY" ] }, "artifact_access_level": { "type": "string", "description": "The artifact access level", "enum": [ "DENIED", "READ_ONLY", "READ_WRITE", "MANAGE" ] }, "routing_access_level": { "type": "string", "description": "The routing access level", "enum": [ "DENIED", "READ_ONLY", "MANAGE" ] }, "target_access_level": { "type": "string", "description": "The target access level", "enum": [ "DENIED", "READ_ONLY", "USE_ONLY", "MANAGE" ] }, "tunnel_agent_access_level": { "type": "string", "description": "Tunnel agent access level", "enum": [ "DENIED", "READ_ONLY", "USE_ONLY", "MANAGE" ] } } }, "ActionRequest": { "type": "object", "discriminator": { "propertyName": "type", "mapping": { "BUILD": "#/components/schemas/BuildActionRequest", "EMAIL": "#/components/schemas/EmailActionRequest", "AMAZON_S3": "#/components/schemas/AmazonS3ActionRequest", "SSH_COMMAND": "#/components/schemas/SshCommandActionRequest", "HTTP": "#/components/schemas/HttpActionRequest", "VISUAL_TESTS": "#/components/schemas/VisualTestsActionRequest", "VISUAL_TEST_2": "#/components/schemas/VisualTest2ActionRequest", "SLACK": "#/components/schemas/SlackActionRequest", "TELEGRAM": "#/components/schemas/TelegramActionRequest", "DISCORD2": "#/components/schemas/DiscordActionRequest", "MICROSOFT_TEAMS": "#/components/schemas/MicrosoftTeamsActionRequest", "GOOGLE_CHAT": "#/components/schemas/GoogleChatActionRequest", "SMS": "#/components/schemas/SmsActionRequest", "PUSHOVER": "#/components/schemas/PushoverActionRequest", "PUSHBULLET": "#/components/schemas/PushbulletActionRequest", "HONEYBADGER": "#/components/schemas/HoneybadgerActionRequest", "NEW_RELIC": "#/components/schemas/NewRelicActionRequest", "ROLLBAR": "#/components/schemas/RollbarActionRequest", "SENTRY": "#/components/schemas/SentryActionRequest", "SENTRY_ENTERPRISE": "#/components/schemas/SentryEnterpriseActionRequest", "DATADOG": "#/components/schemas/DatadogActionRequest", "DATADOG_STATUS_CHECK": "#/components/schemas/DatadogStatusCheckActionRequest", "BUGSNAG": "#/components/schemas/BugsnagActionRequest", "RAYGUN": "#/components/schemas/RaygunActionRequest", "LOGGLY": "#/components/schemas/LogglyActionRequest", "GHOST_INSPECTOR": "#/components/schemas/GhostInspectorActionRequest", "ATOP": "#/components/schemas/AtopActionRequest", "JIRA_BUILD": "#/components/schemas/JiraBuildActionRequest", "JIRA_DEPLOYMENT": "#/components/schemas/JiraDeploymentActionRequest", "DO_SPACES": "#/components/schemas/DoSpacesActionRequest", "BACKBLAZE_B2": "#/components/schemas/BackblazeB2ActionRequest", "GCS": "#/components/schemas/GcsActionRequest", "GOOGLE_CLOUD_STORAGE": "#/components/schemas/GoogleCloudStorageActionRequest", "RACKSPACE": "#/components/schemas/RackspaceActionRequest", "SHOPIFY": "#/components/schemas/ShopifyActionRequest", "WEB_DAV": "#/components/schemas/WebDavActionRequest", "TRANSFER": "#/components/schemas/TransferActionRequest", "AZURE_STORAGE": "#/components/schemas/AzureStorageActionRequest", "DEPLOY_TO_SANDBOX": "#/components/schemas/DeployToSandboxActionRequest", "PUBLISH_ARTIFACT_VERSION": "#/components/schemas/PublishArtifactVersionActionRequest", "POWERSHELL": "#/components/schemas/PowershellActionRequest", "SANDBOX_EXEC": "#/components/schemas/SandboxExecActionRequest", "PUSH": "#/components/schemas/PushActionRequest", "AZURE": "#/components/schemas/AzureActionRequest", "HEROKU": "#/components/schemas/HerokuActionRequest", "WEB": "#/components/schemas/WebActionRequest", "TCP": "#/components/schemas/TcpActionRequest", "PING": "#/components/schemas/PingActionRequest", "STORYBOOK": "#/components/schemas/StorybookActionRequest", "CYPRESS": "#/components/schemas/CypressActionRequest", "PLAYWRIGHT": "#/components/schemas/PlaywrightActionRequest", "CUSTOM": "#/components/schemas/CustomActionRequest", "RUN_DOCKER_CONTAINER": "#/components/schemas/RunDockerContainerActionRequest", "DOCKERFILE": "#/components/schemas/DockerfileActionRequest", "DOCKER_BUILD_MULTI_ARCH": "#/components/schemas/DockerBuildMultiArchActionRequest", "DOCKER_PUSH": "#/components/schemas/DockerPushActionRequest", "GOOGLE_APP_ENGINE": "#/components/schemas/GoogleAppEngineActionRequest", "GOOGLE_APP_DEPLOY": "#/components/schemas/GoogleAppDeployActionRequest", "GCLOUD_CLI": "#/components/schemas/GcloudCliActionRequest", "GOOGLE_CLOUD_CLI": "#/components/schemas/GoogleCloudCliActionRequest", "GCLOUD_RUN_DEPLOY": "#/components/schemas/GcloudRunDeployActionRequest", "GOOGLE_CLOUD_RUN_DEPLOY": "#/components/schemas/GoogleCloudRunDeployActionRequest", "HEROKU_CLI": "#/components/schemas/HerokuCliActionRequest", "AWS_CLI": "#/components/schemas/AwsCliActionRequest", "AWS_CLI_2": "#/components/schemas/AwsCli2ActionRequest", "AWS_CLOUD_FORMATION": "#/components/schemas/AwsCloudFormationActionRequest", "AWS_LAMBDA_DEPLOY": "#/components/schemas/AwsLambdaDeployActionRequest", "GOOGLE_FUNCTIONS_DEPLOY": "#/components/schemas/GoogleFunctionsDeployActionRequest", "GOOGLE_FUNCTION_DEPLOY": "#/components/schemas/GoogleFunctionDeployActionRequest", "RUN_NEXT_PIPELINE": "#/components/schemas/RunNextPipelineActionRequest", "COPY_FILES": "#/components/schemas/CopyFilesActionRequest", "WAIT_FOR_APPLY": "#/components/schemas/WaitForApplyActionRequest", "WAIT_FOR_VARIABLES": "#/components/schemas/WaitForVariablesActionRequest", "SET_VARIABLES": "#/components/schemas/SetVariablesActionRequest", "APPROVE_VT": "#/components/schemas/ApproveVtActionRequest", "ELASTIC_BEANSTALK": "#/components/schemas/AwsElasticBeanstalkActionRequest", "CODE_DEPLOY": "#/components/schemas/AwsCodeDeployActionRequest", "AWS_APP_RUNNER_DEPLOY": "#/components/schemas/AwsAppRunnerDeployActionRequest", "AWS_ECS": "#/components/schemas/AwsEcsActionRequest", "LAMBDA": "#/components/schemas/AwsLambdaInvokeActionRequest", "GOOGLE_FUNCTIONS": "#/components/schemas/GoogleFunctionsActionRequest", "GOOGLE_FUNCTION_INVOKE": "#/components/schemas/GoogleFunctionInvokeActionRequest", "CLOUDFLARE": "#/components/schemas/CloudflareInvalidationActionRequest", "CLOUD_FRONT": "#/components/schemas/CloudFrontInvalidationActionRequest", "GOOGLE_CDN": "#/components/schemas/GoogleCdnActionRequest", "GOOGLE_CDN_INVALIDATE": "#/components/schemas/GoogleCdnInvalidateActionRequest", "DIGITAL_OCEAN_CDN": "#/components/schemas/DigitalOceanCdnInvalidationActionRequest", "RSYNC": "#/components/schemas/RsyncActionRequest", "MONITOR": "#/components/schemas/AwsElasticBeanstalkMonitorActionRequest", "AWS_APP_RUNNER_MONITOR": "#/components/schemas/AwsAppRunnerMonitorActionRequest", "SLEEP": "#/components/schemas/SleepActionRequest", "KUBERNETES_APPLY": "#/components/schemas/KubernetesApplyActionRequest", "KUBERNETES_SET_IMAGE": "#/components/schemas/KubernetesSetImageActionRequest", "KUBERNETES_RUN_POD": "#/components/schemas/KubernetesRunPodActionRequest", "KUBERNETES_RUN_JOB": "#/components/schemas/KubernetesRunJobActionRequest", "KUBERNETES_CLI": "#/components/schemas/KubernetesCliActionRequest", "HELM": "#/components/schemas/HelmActionRequest", "ZIP": "#/components/schemas/ZipActionRequest", "ESLINT": "#/components/schemas/EslintActionRequest", "ANDROID_SIGN": "#/components/schemas/AndroidSignActionRequest", "ANDROID_SIGN_BUNDLE": "#/components/schemas/AndroidSignBundleActionRequest", "ANDROID_PLAY": "#/components/schemas/AndroidPlayActionRequest", "ANDROID_PLAY_BUNDLE": "#/components/schemas/AndroidPlayBundleActionRequest", "ANDROID_PUBLISH_APK": "#/components/schemas/AndroidPublishApkActionRequest", "ANDROID_PUBLISH_APP_BUNDLE": "#/components/schemas/AndroidPublishAppBundleActionRequest", "FIREBASE": "#/components/schemas/FirebaseActionRequest", "NETLIFY": "#/components/schemas/NetlifyActionRequest", "LIGHTHOUSE": "#/components/schemas/LighthouseActionRequest", "REPLACE": "#/components/schemas/ReplaceActionRequest", "GIT_CRYPT_UNLOCK": "#/components/schemas/GitCryptUnlockActionRequest", "GIT_CRYPT_LOCK": "#/components/schemas/GitCryptLockActionRequest", "SPLIT_TESTS": "#/components/schemas/SplitTestsActionRequest", "IMAGE_COMPRESSION": "#/components/schemas/ImageCompressionActionRequest", "DOCKERFILE_LINTER": "#/components/schemas/DockerfileLinterActionRequest", "DOWNLOAD": "#/components/schemas/DownloadFtpActionRequest", "DOWNLOAD_S3": "#/components/schemas/DownloadS3ActionRequest", "DOWNLOAD_FROM_SANDBOX": "#/components/schemas/DownloadFromSandboxActionRequest", "DOWNLOAD_GCS": "#/components/schemas/DownloadFromGcsActionRequest", "DOWNLOAD_BACKBLAZE_B2": "#/components/schemas/DownloadBackblazeActionRequest", "DOWNLOAD_ARTIFACT_VERSION": "#/components/schemas/DownloadArtifactActionRequest", "SANDBOX_START": "#/components/schemas/SandboxStartActionRequest", "SANDBOX_STOP": "#/components/schemas/SandboxStopActionRequest", "SANDBOX_SNAPSHOT": "#/components/schemas/SandboxSnapshotActionRequest", "SANDBOX_CREATE_NEW": "#/components/schemas/SandboxCreateNewActionRequest", "SANDBOX_CREATE_FROM_SANDBOX": "#/components/schemas/SandboxCreateFromSandboxActionRequest", "SANDBOX_CREATE_FROM_SNAPSHOT": "#/components/schemas/SandboxCreateFromSnapshotActionRequest", "SANDBOX_DELETE": "#/components/schemas/SandboxDeleteActionRequest", "SANDBOX_APPLICATION_START": "#/components/schemas/SandboxApplicationStartActionRequest", "SANDBOX_APPLICATION_STOP": "#/components/schemas/SandboxApplicationStopActionRequest", "SANDBOX_MANAGE": "#/components/schemas/ManageSandboxActionRequest", "SANDBOX_CREATE": "#/components/schemas/CreateSandboxActionRequest", "LINK_VALIDATOR": "#/components/schemas/LinkValidatorActionRequest", "LINK_CHECKER": "#/components/schemas/LinkCheckerActionRequest", "AZURE_CLI": "#/components/schemas/AzureCliActionRequest", "SHOPIFY_THEMEKIT_CLI": "#/components/schemas/ShopifyThemekitActionRequest", "SHOPIFY_CLI": "#/components/schemas/ShopifyCliActionRequest", "SSL_VERIFY": "#/components/schemas/SslVerifyActionRequest", "GIT_HUB_RELEASE": "#/components/schemas/GitHubReleaseActionRequest", "NATIVE_BUILD_WINDOWS": "#/components/schemas/WindowsNativeBuildActionRequest", "NATIVE_BUILD_MAC": "#/components/schemas/MacNativeBuildActionRequest", "NATIVE_BUILD_MAC_VM": "#/components/schemas/MacVmNativeBuildActionRequest", "NATIVE_BUILD_MAC_REACT": "#/components/schemas/MacReactNativeBuildActionRequest", "NATIVE_BUILD_MAC_CORDOVA": "#/components/schemas/MacCordovaNativeBuildActionRequest", "NATIVE_BUILD_MAC_FASTLANE": "#/components/schemas/MacFastlaneNativeBuildActionRequest", "NATIVE_BUILD_MAC_FLUTTER": "#/components/schemas/MacFlutterNativeBuildActionRequest", "NATIVE_BUILD_MAC_SIGN": "#/components/schemas/MacSignNativeBuildActionRequest", "NATIVE_BUILD_MAC_DEPLOY": "#/components/schemas/MacDeployNativeBuildActionRequest", "NATIVE_BUILD_DOCKER_CLI": "#/components/schemas/DockerCliNativeBuildActionRequest", "NATIVE_BUILD_LINUX": "#/components/schemas/LinuxNativeBuildActionRequest", "DOCTL": "#/components/schemas/DoctlActionRequest", "CLEAR_CACHE": "#/components/schemas/ClearCacheActionRequest", "FASTLANE_ANDROID": "#/components/schemas/FastlaneAndroidActionRequest", "GIT_HUB_CLI": "#/components/schemas/GitHubCliActionRequest", "GIT_LAB_CLI": "#/components/schemas/GitLabCliActionRequest", "INTEGRATION_VARIABLES": "#/components/schemas/IntegrationVariablesActionRequest", "CODE_PIPELINE": "#/components/schemas/CodePipelineActionRequest", "AWS_CDK_CLI": "#/components/schemas/AwsCdkCliActionRequest", "GHOST_INSPECTOR_CLI": "#/components/schemas/GhostInspectorCliActionRequest", "TERRAFORM": "#/components/schemas/TerraformActionRequest", "SNYK_CLI": "#/components/schemas/SnykActionRequest", "STACK_HAWK_CLI": "#/components/schemas/StackHawkActionRequest", "JMETER_CLI": "#/components/schemas/JmeterActionRequest", "TRIVY_CLI": "#/components/schemas/TrivyCliActionRequest", "BLACKFIRE_PHP": "#/components/schemas/BlackfirePhpActionRequest", "BLACKFIRE_PYTHON": "#/components/schemas/BlackfirePythonActionRequest", "BLACKFIRE_GO": "#/components/schemas/BlackfireGoActionRequest", "DOCKER": "#/components/schemas/DockerCliActionRequest", "PIPELINE_SETTINGS": "#/components/schemas/PipelineSettingsActionRequest", "NEW_RELIC_CLI": "#/components/schemas/NewRelicCliActionRequest", "CONTENTFUL_CLI": "#/components/schemas/ContentfulCliActionRequest", "WP_CLI": "#/components/schemas/WpCliActionRequest", "PROMOTE_IMAGE": "#/components/schemas/PromoteImageActionRequest", "GIT_MERGE": "#/components/schemas/GitMergeActionRequest", "MYSQL_CLI": "#/components/schemas/MysqlCliActionRequest", "MONGOSH_CLI": "#/components/schemas/MongoshCliActionRequest", "MSSQL_CLI": "#/components/schemas/MssqlCliActionRequest", "CRAWL": "#/components/schemas/CrawlActionRequest", "NPM_PUBLISH": "#/components/schemas/NpmPublishActionRequest", "POSTGRESQL_CLI": "#/components/schemas/PostgresqlCliActionRequest", "CLAUDE_CODE": "#/components/schemas/ClaudeCodeActionRequest" } }, "oneOf": [ { "$ref": "#/components/schemas/BuildActionRequest" }, { "$ref": "#/components/schemas/EmailActionRequest" }, { "$ref": "#/components/schemas/AmazonS3ActionRequest" }, { "$ref": "#/components/schemas/SshCommandActionRequest" }, { "$ref": "#/components/schemas/HttpActionRequest" }, { "$ref": "#/components/schemas/VisualTestsActionRequest" }, { "$ref": "#/components/schemas/VisualTest2ActionRequest" }, { "$ref": "#/components/schemas/SlackActionRequest" }, { "$ref": "#/components/schemas/TelegramActionRequest" }, { "$ref": "#/components/schemas/DiscordActionRequest" }, { "$ref": "#/components/schemas/MicrosoftTeamsActionRequest" }, { "$ref": "#/components/schemas/GoogleChatActionRequest" }, { "$ref": "#/components/schemas/SmsActionRequest" }, { "$ref": "#/components/schemas/PushoverActionRequest" }, { "$ref": "#/components/schemas/PushbulletActionRequest" }, { "$ref": "#/components/schemas/HoneybadgerActionRequest" }, { "$ref": "#/components/schemas/NewRelicActionRequest" }, { "$ref": "#/components/schemas/RollbarActionRequest" }, { "$ref": "#/components/schemas/SentryActionRequest" }, { "$ref": "#/components/schemas/SentryEnterpriseActionRequest" }, { "$ref": "#/components/schemas/DatadogActionRequest" }, { "$ref": "#/components/schemas/DatadogStatusCheckActionRequest" }, { "$ref": "#/components/schemas/BugsnagActionRequest" }, { "$ref": "#/components/schemas/RaygunActionRequest" }, { "$ref": "#/components/schemas/LogglyActionRequest" }, { "$ref": "#/components/schemas/GhostInspectorActionRequest" }, { "$ref": "#/components/schemas/AtopActionRequest" }, { "$ref": "#/components/schemas/JiraBuildActionRequest" }, { "$ref": "#/components/schemas/JiraDeploymentActionRequest" }, { "$ref": "#/components/schemas/DoSpacesActionRequest" }, { "$ref": "#/components/schemas/BackblazeB2ActionRequest" }, { "$ref": "#/components/schemas/GcsActionRequest" }, { "$ref": "#/components/schemas/GoogleCloudStorageActionRequest" }, { "$ref": "#/components/schemas/RackspaceActionRequest" }, { "$ref": "#/components/schemas/ShopifyActionRequest" }, { "$ref": "#/components/schemas/WebDavActionRequest" }, { "$ref": "#/components/schemas/TransferActionRequest" }, { "$ref": "#/components/schemas/AzureStorageActionRequest" }, { "$ref": "#/components/schemas/DeployToSandboxActionRequest" }, { "$ref": "#/components/schemas/PublishArtifactVersionActionRequest" }, { "$ref": "#/components/schemas/PowershellActionRequest" }, { "$ref": "#/components/schemas/SandboxExecActionRequest" }, { "$ref": "#/components/schemas/PushActionRequest" }, { "$ref": "#/components/schemas/AzureActionRequest" }, { "$ref": "#/components/schemas/HerokuActionRequest" }, { "$ref": "#/components/schemas/WebActionRequest" }, { "$ref": "#/components/schemas/TcpActionRequest" }, { "$ref": "#/components/schemas/PingActionRequest" }, { "$ref": "#/components/schemas/StorybookActionRequest" }, { "$ref": "#/components/schemas/CypressActionRequest" }, { "$ref": "#/components/schemas/PlaywrightActionRequest" }, { "$ref": "#/components/schemas/CustomActionRequest" }, { "$ref": "#/components/schemas/RunDockerContainerActionRequest" }, { "$ref": "#/components/schemas/DockerfileActionRequest" }, { "$ref": "#/components/schemas/DockerBuildMultiArchActionRequest" }, { "$ref": "#/components/schemas/DockerPushActionRequest" }, { "$ref": "#/components/schemas/GoogleAppEngineActionRequest" }, { "$ref": "#/components/schemas/GoogleAppDeployActionRequest" }, { "$ref": "#/components/schemas/GcloudCliActionRequest" }, { "$ref": "#/components/schemas/GoogleCloudCliActionRequest" }, { "$ref": "#/components/schemas/GcloudRunDeployActionRequest" }, { "$ref": "#/components/schemas/GoogleCloudRunDeployActionRequest" }, { "$ref": "#/components/schemas/HerokuCliActionRequest" }, { "$ref": "#/components/schemas/AwsCliActionRequest" }, { "$ref": "#/components/schemas/AwsCli2ActionRequest" }, { "$ref": "#/components/schemas/AwsCloudFormationActionRequest" }, { "$ref": "#/components/schemas/AwsLambdaDeployActionRequest" }, { "$ref": "#/components/schemas/GoogleFunctionsDeployActionRequest" }, { "$ref": "#/components/schemas/GoogleFunctionDeployActionRequest" }, { "$ref": "#/components/schemas/RunNextPipelineActionRequest" }, { "$ref": "#/components/schemas/CopyFilesActionRequest" }, { "$ref": "#/components/schemas/WaitForApplyActionRequest" }, { "$ref": "#/components/schemas/WaitForVariablesActionRequest" }, { "$ref": "#/components/schemas/SetVariablesActionRequest" }, { "$ref": "#/components/schemas/ApproveVtActionRequest" }, { "$ref": "#/components/schemas/AwsElasticBeanstalkActionRequest" }, { "$ref": "#/components/schemas/AwsCodeDeployActionRequest" }, { "$ref": "#/components/schemas/AwsAppRunnerDeployActionRequest" }, { "$ref": "#/components/schemas/AwsEcsActionRequest" }, { "$ref": "#/components/schemas/AwsLambdaInvokeActionRequest" }, { "$ref": "#/components/schemas/GoogleFunctionsActionRequest" }, { "$ref": "#/components/schemas/GoogleFunctionInvokeActionRequest" }, { "$ref": "#/components/schemas/CloudflareInvalidationActionRequest" }, { "$ref": "#/components/schemas/CloudFrontInvalidationActionRequest" }, { "$ref": "#/components/schemas/GoogleCdnActionRequest" }, { "$ref": "#/components/schemas/GoogleCdnInvalidateActionRequest" }, { "$ref": "#/components/schemas/DigitalOceanCdnInvalidationActionRequest" }, { "$ref": "#/components/schemas/RsyncActionRequest" }, { "$ref": "#/components/schemas/AwsElasticBeanstalkMonitorActionRequest" }, { "$ref": "#/components/schemas/AwsAppRunnerMonitorActionRequest" }, { "$ref": "#/components/schemas/SleepActionRequest" }, { "$ref": "#/components/schemas/KubernetesApplyActionRequest" }, { "$ref": "#/components/schemas/KubernetesSetImageActionRequest" }, { "$ref": "#/components/schemas/KubernetesRunPodActionRequest" }, { "$ref": "#/components/schemas/KubernetesRunJobActionRequest" }, { "$ref": "#/components/schemas/KubernetesCliActionRequest" }, { "$ref": "#/components/schemas/HelmActionRequest" }, { "$ref": "#/components/schemas/ZipActionRequest" }, { "$ref": "#/components/schemas/EslintActionRequest" }, { "$ref": "#/components/schemas/AndroidSignActionRequest" }, { "$ref": "#/components/schemas/AndroidSignBundleActionRequest" }, { "$ref": "#/components/schemas/AndroidPlayActionRequest" }, { "$ref": "#/components/schemas/AndroidPlayBundleActionRequest" }, { "$ref": "#/components/schemas/AndroidPublishApkActionRequest" }, { "$ref": "#/components/schemas/AndroidPublishAppBundleActionRequest" }, { "$ref": "#/components/schemas/FirebaseActionRequest" }, { "$ref": "#/components/schemas/NetlifyActionRequest" }, { "$ref": "#/components/schemas/LighthouseActionRequest" }, { "$ref": "#/components/schemas/ReplaceActionRequest" }, { "$ref": "#/components/schemas/GitCryptUnlockActionRequest" }, { "$ref": "#/components/schemas/GitCryptLockActionRequest" }, { "$ref": "#/components/schemas/SplitTestsActionRequest" }, { "$ref": "#/components/schemas/ImageCompressionActionRequest" }, { "$ref": "#/components/schemas/DockerfileLinterActionRequest" }, { "$ref": "#/components/schemas/DownloadFtpActionRequest" }, { "$ref": "#/components/schemas/DownloadS3ActionRequest" }, { "$ref": "#/components/schemas/DownloadFromSandboxActionRequest" }, { "$ref": "#/components/schemas/DownloadFromGcsActionRequest" }, { "$ref": "#/components/schemas/DownloadBackblazeActionRequest" }, { "$ref": "#/components/schemas/DownloadArtifactActionRequest" }, { "$ref": "#/components/schemas/SandboxStartActionRequest" }, { "$ref": "#/components/schemas/SandboxStopActionRequest" }, { "$ref": "#/components/schemas/SandboxSnapshotActionRequest" }, { "$ref": "#/components/schemas/SandboxCreateNewActionRequest" }, { "$ref": "#/components/schemas/SandboxCreateFromSandboxActionRequest" }, { "$ref": "#/components/schemas/SandboxCreateFromSnapshotActionRequest" }, { "$ref": "#/components/schemas/SandboxDeleteActionRequest" }, { "$ref": "#/components/schemas/SandboxApplicationStartActionRequest" }, { "$ref": "#/components/schemas/SandboxApplicationStopActionRequest" }, { "$ref": "#/components/schemas/ManageSandboxActionRequest" }, { "$ref": "#/components/schemas/CreateSandboxActionRequest" }, { "$ref": "#/components/schemas/LinkValidatorActionRequest" }, { "$ref": "#/components/schemas/LinkCheckerActionRequest" }, { "$ref": "#/components/schemas/AzureCliActionRequest" }, { "$ref": "#/components/schemas/ShopifyThemekitActionRequest" }, { "$ref": "#/components/schemas/ShopifyCliActionRequest" }, { "$ref": "#/components/schemas/SslVerifyActionRequest" }, { "$ref": "#/components/schemas/GitHubReleaseActionRequest" }, { "$ref": "#/components/schemas/WindowsNativeBuildActionRequest" }, { "$ref": "#/components/schemas/MacNativeBuildActionRequest" }, { "$ref": "#/components/schemas/MacVmNativeBuildActionRequest" }, { "$ref": "#/components/schemas/MacReactNativeBuildActionRequest" }, { "$ref": "#/components/schemas/MacCordovaNativeBuildActionRequest" }, { "$ref": "#/components/schemas/MacFastlaneNativeBuildActionRequest" }, { "$ref": "#/components/schemas/MacFlutterNativeBuildActionRequest" }, { "$ref": "#/components/schemas/MacSignNativeBuildActionRequest" }, { "$ref": "#/components/schemas/MacDeployNativeBuildActionRequest" }, { "$ref": "#/components/schemas/DockerCliNativeBuildActionRequest" }, { "$ref": "#/components/schemas/LinuxNativeBuildActionRequest" }, { "$ref": "#/components/schemas/DoctlActionRequest" }, { "$ref": "#/components/schemas/ClearCacheActionRequest" }, { "$ref": "#/components/schemas/FastlaneAndroidActionRequest" }, { "$ref": "#/components/schemas/GitHubCliActionRequest" }, { "$ref": "#/components/schemas/GitLabCliActionRequest" }, { "$ref": "#/components/schemas/IntegrationVariablesActionRequest" }, { "$ref": "#/components/schemas/CodePipelineActionRequest" }, { "$ref": "#/components/schemas/AwsCdkCliActionRequest" }, { "$ref": "#/components/schemas/GhostInspectorCliActionRequest" }, { "$ref": "#/components/schemas/TerraformActionRequest" }, { "$ref": "#/components/schemas/SnykActionRequest" }, { "$ref": "#/components/schemas/StackHawkActionRequest" }, { "$ref": "#/components/schemas/JmeterActionRequest" }, { "$ref": "#/components/schemas/TrivyCliActionRequest" }, { "$ref": "#/components/schemas/BlackfirePhpActionRequest" }, { "$ref": "#/components/schemas/BlackfirePythonActionRequest" }, { "$ref": "#/components/schemas/BlackfireGoActionRequest" }, { "$ref": "#/components/schemas/DockerCliActionRequest" }, { "$ref": "#/components/schemas/PipelineSettingsActionRequest" }, { "$ref": "#/components/schemas/NewRelicCliActionRequest" }, { "$ref": "#/components/schemas/ContentfulCliActionRequest" }, { "$ref": "#/components/schemas/WpCliActionRequest" }, { "$ref": "#/components/schemas/PromoteImageActionRequest" }, { "$ref": "#/components/schemas/GitMergeActionRequest" }, { "$ref": "#/components/schemas/MysqlCliActionRequest" }, { "$ref": "#/components/schemas/MongoshCliActionRequest" }, { "$ref": "#/components/schemas/MssqlCliActionRequest" }, { "$ref": "#/components/schemas/CrawlActionRequest" }, { "$ref": "#/components/schemas/NpmPublishActionRequest" }, { "$ref": "#/components/schemas/PostgresqlCliActionRequest" }, { "$ref": "#/components/schemas/ClaudeCodeActionRequest" } ] }, "AmazonIntegrationRef": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" } }, "description": "Amazon integration (AMAZON)" }, "AmazonS3ActionRequest": { "required": [ "bucket_name", "integration", "local_path", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The current git revision" }, "local_path": { "type": "string", "description": "The path to the local files to deploy" }, "remote_path": { "type": "string", "description": "The path on the remote server where files will be deployed" }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "deployment_includes": { "type": "array", "description": "The list of files or directories to include in deployment", "items": { "type": "string", "description": "The list of files or directories to include in deployment" } }, "input_type": { "type": "string", "description": "The type of source input", "enum": [ "SCM_REPOSITORY", "BUILD_ARTIFACTS" ] }, "deletion_disabled": { "type": "boolean", "description": "If set to `true`, files on the remote server will not be deleted" }, "use_temporary_files": { "type": "boolean", "description": "If set to `true`, files will be uploaded to a temporary directory first" }, "content_encoding": { "type": "string", "description": "The content encoding for deployed files" }, "integration": { "$ref": "#/components/schemas/AmazonIntegrationRef" }, "bucket_name": { "type": "string", "description": "The name of the Amazon S3 Bucket" }, "public_access": { "type": "boolean", "description": "Defines whether the bucket has public access" }, "acl": { "type": "string", "description": "Controls bucket access permissions", "enum": [ "PRIVATE", "PUBLIC_READ", "PUBLIC_READ_WRITE", "AWS_EXEC_READ", "AUTHENTICATED_READ", "BUCKET_OWNER_READ", "BUCKET_OWNER_FULL_CONTROL", "LOG_DELIVERY_WRITE" ] }, "reduced_redundancy": { "type": "boolean", "description": "Set to `true` if you want to use Reduced Redundancy Storage" }, "cache_control": { "type": "string", "description": "Specifies how long objects stay in the cache" }, "expires_date": { "type": "string", "description": "Specifies the expiration period for the objects (how long they stay in the cache)", "format": "date-time" }, "skip_content_type_setting": { "type": "boolean", "description": "When set to `true` all files will have their mime-types set to `application/octet-stream`" }, "deploy_tags": { "type": "array", "description": "Defines tags for files categorization as a key value pairs list", "items": { "$ref": "#/components/schemas/DeploymentTagView" } } }, "x-name": "Amazon S3" }, "AmiView": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the Amazon Machine Image (AMI)" }, "port": { "type": "string", "description": "The SSH port for connecting to the AMI instance" }, "user": { "type": "string", "description": "The SSH username for connecting to the AMI instance" }, "password": { "type": "string", "description": "The SSH password for connecting to the AMI instance" } }, "description": "Set if `distribution` is set to `AMI`." }, "AndroidPlayActionRequest": { "required": [ "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "integration": { "$ref": "#/components/schemas/GooglePlayStoreIntegrationRef" }, "application_id": { "type": "string", "description": "The ID of the Android Application" }, "track": { "type": "string", "description": "The track type to read or modify" }, "user_fraction": { "type": "number", "description": "Portion of the users who should get the staged rollout version of the APK (range 0.0 - 1.0)", "format": "double" }, "mapping_path": { "type": "string", "description": "The path to the deobfuscated file of the specified APK" }, "changes_path": { "type": "string", "description": "The path to the changelog file" }, "supersede_versions": { "type": "boolean", "description": "Check and disable superseded versions in other tracks (if any)" }, "draft": { "type": "boolean", "description": "Set to `true` to publish as a draft" }, "changes_not_sent_for_review": { "type": "boolean", "description": "If set to `true`, changes will not be sent for review" }, "apk_files": { "uniqueItems": true, "type": "array", "description": "The list of sets of paths to the APKs", "items": { "$ref": "#/components/schemas/ApkFileView" } }, "key_path": { "type": "string", "description": "The path to the service account key file" } }, "deprecated": true, "x-name": "Publish Android Application" }, "AndroidPlayBundleActionRequest": { "required": [ "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "integration": { "$ref": "#/components/schemas/GooglePlayStoreIntegrationRef" }, "application_id": { "type": "string", "description": "The ID of the Android Application" }, "track": { "type": "string", "description": "The track type to read or modify" }, "user_fraction": { "type": "number", "description": "Portion of the users who should get the staged rollout version of the APK (range 0.0 - 1.0)", "format": "double" }, "mapping_path": { "type": "string", "description": "The path to the deobfuscated file of the specified APK" }, "changes_path": { "type": "string", "description": "The path to the changelog file" }, "supersede_versions": { "type": "boolean", "description": "Check and disable superseded versions in other tracks (if any)" }, "draft": { "type": "boolean", "description": "Set to `true` to publish as a draft" }, "changes_not_sent_for_review": { "type": "boolean", "description": "If set to `true`, changes will not be sent for review" }, "apk_files": { "uniqueItems": true, "type": "array", "description": "The list of sets of paths to the APKs", "items": { "$ref": "#/components/schemas/ApkFileView" } }, "key_path": { "type": "string", "description": "The path to the service account key file" } }, "deprecated": true, "x-name": "Publish Bundle to Google Play" }, "AndroidPublishApkActionRequest": { "required": [ "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "integration": { "$ref": "#/components/schemas/GooglePlayStoreIntegrationRef" }, "application_id": { "type": "string", "description": "The ID of the Android Application" }, "track": { "type": "string", "description": "The track type to read or modify" }, "user_fraction": { "type": "number", "description": "Portion of the users who should get the staged rollout version of the APK (range 0.0 - 1.0)", "format": "double" }, "mapping_path": { "type": "string", "description": "The path to the deobfuscated file of the specified APK" }, "changes_path": { "type": "string", "description": "The path to the changelog file" }, "supersede_versions": { "type": "boolean", "description": "Check and disable superseded versions in other tracks (if any)" }, "draft": { "type": "boolean", "description": "Set to `true` to publish as a draft" }, "changes_not_sent_for_review": { "type": "boolean", "description": "If set to `true`, changes will not be sent for review" }, "apk_files": { "uniqueItems": true, "type": "array", "description": "The list of sets of paths to the APKs", "items": { "$ref": "#/components/schemas/ApkFileView" } }, "key_path": { "type": "string", "description": "The path to the service account key file" } }, "x-name": "Publish Android Application" }, "AndroidPublishAppBundleActionRequest": { "required": [ "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "integration": { "$ref": "#/components/schemas/GooglePlayStoreIntegrationRef" }, "application_id": { "type": "string", "description": "The ID of the Android Application" }, "track": { "type": "string", "description": "The track type to read or modify" }, "user_fraction": { "type": "number", "description": "Portion of the users who should get the staged rollout version of the APK (range 0.0 - 1.0)", "format": "double" }, "mapping_path": { "type": "string", "description": "The path to the deobfuscated file of the specified APK" }, "changes_path": { "type": "string", "description": "The path to the changelog file" }, "supersede_versions": { "type": "boolean", "description": "Check and disable superseded versions in other tracks (if any)" }, "draft": { "type": "boolean", "description": "Set to `true` to publish as a draft" }, "changes_not_sent_for_review": { "type": "boolean", "description": "If set to `true`, changes will not be sent for review" }, "apk_files": { "uniqueItems": true, "type": "array", "description": "The list of sets of paths to the APKs", "items": { "$ref": "#/components/schemas/ApkFileView" } }, "key_path": { "type": "string", "description": "The path to the service account key file" } }, "x-name": "Publish Bundle to Google Play" }, "AndroidSignActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "local_path": { "type": "string", "description": "The path to the Android application file (APK or AAB)" }, "application_name": { "type": "string", "description": "The name of the Android application" }, "output_dir": { "type": "string", "description": "The directory where the signed application will be saved" }, "key_path": { "type": "string", "description": "The path to the keystore file" }, "key_alias": { "type": "string", "description": "The alias of the key in the keystore" }, "key_password": { "type": "string", "description": "The password for the key" }, "keystore_password": { "type": "string", "description": "The password for the keystore" }, "build_tool_version": { "type": "string", "description": "The version of the Android Build Tools" } }, "x-name": "Sign Android Application" }, "AndroidSignBundleActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "local_path": { "type": "string", "description": "The path to the Android application file (APK or AAB)" }, "application_name": { "type": "string", "description": "The name of the Android application" }, "output_dir": { "type": "string", "description": "The directory where the signed application will be saved" }, "key_path": { "type": "string", "description": "The path to the keystore file" }, "key_alias": { "type": "string", "description": "The alias of the key in the keystore" }, "key_password": { "type": "string", "description": "The password for the key" }, "keystore_password": { "type": "string", "description": "The password for the keystore" } }, "x-name": "Sign Bundle" }, "ApkFileView": { "type": "object", "properties": { "apk_path": { "type": "string", "description": "The path to the main APK file" }, "main_expansion_path": { "type": "string", "description": "The path to the main expansion (OBB) file" }, "patch_expansion_path": { "type": "string", "description": "The path to the patch expansion (OBB) file" } }, "description": "The list of sets of paths to the APKs" }, "AppStoreIntegrationRef": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" } }, "description": "App Store integration (APP_STORE)" }, "ApproveVtActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "comment": { "type": "string", "description": "The comment for the wait action" }, "description": { "type": "string", "description": "The description of the wait action" }, "prevent_self_approval": { "type": "boolean", "description": "If set to `true`, the approver must be different from the person who triggered the run. Default: `false`." }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "from_action": { "type": "string", "description": "The ID of the action from which visual test results are retrieved" }, "suite": { "type": "string", "description": "The name of the visual test suite to approve" }, "ref": { "type": "string", "description": "The git reference (branch, tag, or commit) for which to approve visual test results" } }, "x-name": "Approve Visual Tests" }, "AtopActionRequest": { "required": [ "api_url", "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "integration": { "$ref": "#/components/schemas/AtopIntegrationRef" }, "api_url": { "type": "string", "description": "The URL of the ATOP API endpoint" }, "parameters": { "type": "array", "description": "The list of parameters to send with the ATOP notification", "items": { "$ref": "#/components/schemas/Parameter" } } }, "x-name": "Atop" }, "AtopIntegrationRef": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" } }, "description": "Atop integration (ATOP)" }, "AwsAppRunnerDeployActionRequest": { "required": [ "integration", "name", "region", "service", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "integration": { "$ref": "#/components/schemas/AmazonIntegrationRef" }, "region": { "type": "string", "description": "The AWS region where the App Runner service is located" }, "service": { "type": "string", "description": "The ID of the App Runner service ARN" } }, "x-name": "AWS App Runner Deploy" }, "AwsAppRunnerMonitorActionRequest": { "required": [ "integration", "name", "region", "service", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "region": { "type": "string", "description": "The region to monitor" }, "integration": { "$ref": "#/components/schemas/AmazonIntegrationRef" }, "service": { "type": "string", "description": "The ID of the App Runner service ARN" } }, "x-name": "AWS App Runner Monitor" }, "AwsCdkCliActionRequest": { "required": [ "execute_commands", "integration", "name", "region", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/AmazonIntegrationRef" }, "region": { "type": "string", "description": "The name of the Amazon region" } }, "x-name": "AWS CDK CLI" }, "AwsCli2ActionRequest": { "required": [ "execute_commands", "integration", "name", "region", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/AmazonIntegrationRef" }, "region": { "type": "string", "description": "The Amazon S3 region" } }, "x-name": "AWS CLI 2" }, "AwsCliActionRequest": { "required": [ "execute_commands", "integration", "name", "region", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/AmazonIntegrationRef" }, "region": { "type": "string", "description": "The Amazon S3 region" } }, "x-name": "AWS CLI" }, "AwsCloudFormationActionRequest": { "required": [ "execute_commands", "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/AmazonIntegrationRef" }, "region": { "type": "string", "description": "The Amazon region" } }, "x-name": "AWS CloudFormation" }, "AwsCodeDeployActionRequest": { "required": [ "application_name", "integration", "name", "region", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "region": { "type": "string", "description": "The AWS region" }, "local_path": { "type": "string", "description": "The path to the local files to deploy" }, "application_name": { "type": "string", "description": "The name of the AWS application" }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "deployment_includes": { "type": "array", "description": "The list of files or directories to include in deployment", "items": { "type": "string", "description": "The list of files or directories to include in deployment" } }, "integration": { "$ref": "#/components/schemas/AmazonIntegrationRef" }, "version_label": { "type": "string", "description": "The version label for the deployment" }, "group_name": { "type": "string", "description": "The name of the deployment group" }, "config_name": { "type": "string", "description": "The name of the deployment configuration" }, "description": { "type": "string", "description": "The description of the deployment" }, "ignore_application_stop_failures": { "type": "boolean", "description": "If set to `true`, application stop failures will be ignored" }, "update_outdated_instances_only": { "type": "boolean", "description": "If set to `true`, only outdated instances will be updated" }, "wait_for_finish_deployment": { "type": "boolean", "description": "If set to `true`, the action will wait for the deployment to finish" }, "file_exist_behavior": { "type": "string", "description": "The behavior when files already exist" }, "bucket_name": { "type": "string", "description": "The name of the S3 bucket for deployment" } }, "x-name": "CodeDeploy" }, "AwsEcsActionRequest": { "required": [ "cluster", "integration", "local_path", "name", "region", "service", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "integration": { "$ref": "#/components/schemas/AmazonIntegrationRef" }, "region": { "type": "string", "description": "The Amazon region" }, "local_path": { "type": "string", "description": "The path to the JSON file with task definition" }, "cluster": { "type": "string", "description": "The name of the ECS cluster" }, "service": { "type": "string", "description": "The ID of the ECS service" } }, "x-name": "AWS ECS" }, "AwsElasticBeanstalkActionRequest": { "required": [ "application_name", "environment", "integration", "name", "region", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "region": { "type": "string", "description": "The AWS region" }, "local_path": { "type": "string", "description": "The path to the local files to deploy" }, "application_name": { "type": "string", "description": "The name of the AWS application" }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "deployment_includes": { "type": "array", "description": "The list of files or directories to include in deployment", "items": { "type": "string", "description": "The list of files or directories to include in deployment" } }, "integration": { "$ref": "#/components/schemas/AmazonIntegrationRef" }, "environment": { "type": "string", "description": "The name of the Elastic Beanstalk environment" }, "version_label": { "type": "string", "description": "The version label for the deployment" }, "bucket_name": { "type": "string", "description": "The name of the S3 bucket for deployment" } }, "x-name": "Elastic Beanstalk" }, "AwsElasticBeanstalkMonitorActionRequest": { "required": [ "application_name", "environment", "integration", "name", "region", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "region": { "type": "string", "description": "The region to monitor" }, "integration": { "$ref": "#/components/schemas/AmazonIntegrationRef" }, "application_name": { "type": "string", "description": "The name of the Elastic Beanstalk application to monitor" }, "environment": { "type": "string", "description": "The name of the Elastic Beanstalk environment to monitor" }, "fail_on_yellow": { "type": "boolean", "description": "If set to `true`, the action will fail when the environment health status is Yellow" }, "verbose": { "type": "boolean", "description": "If set to `true`, detailed monitoring information will be displayed" }, "wait_if_grey": { "type": "integer", "description": "The number of seconds to wait if the environment health status is Grey before checking again", "format": "int32" } }, "x-name": "Elastic Beanstalk Monitor" }, "AwsLambdaDeployActionRequest": { "required": [ "function_name", "integration", "name", "region", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "integration": { "$ref": "#/components/schemas/AmazonIntegrationRef" }, "region": { "type": "string", "description": "The Amazon region" }, "local_path": { "type": "string", "description": "The path in the repository" }, "function_name": { "type": "string", "description": "The name of the Lambda function" }, "deployment_excludes": { "type": "array", "description": "The paths and/or files that will be left out during the deployment", "items": { "type": "string", "description": "The paths and/or files that will be left out during the deployment" } }, "deployment_includes": { "type": "array", "description": "The exceptions from the ignore patterns set in `deployment_excludes`", "items": { "type": "string", "description": "The exceptions from the ignore patterns set in `deployment_excludes`" } } }, "x-name": "AWS Lambda Deploy" }, "AwsLambdaInvokeActionRequest": { "required": [ "function_name", "integration", "name", "region", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "function_name": { "type": "string", "description": "The name of the function to invoke" }, "region": { "type": "string", "description": "The region where the function is located" }, "payload": { "type": "string", "description": "The payload to send to the function" }, "integration": { "$ref": "#/components/schemas/AmazonIntegrationRef" }, "qualifier": { "type": "string", "description": "The version or alias to invoke. If not specified, the latest version is used" }, "invocation_type": { "type": "string", "description": "The invocation type. Can be `RequestResponse` (default), `Event`, or `DryRun`" }, "log_type": { "type": "string", "description": "Set to `Tail` to include the execution log in the response" }, "client_context": { "type": "string", "description": "Client-specific information passed to the Lambda function" } }, "x-name": "AWS Lambda" }, "AzureActionRequest": { "required": [ "git_auth_mode", "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "push_tags": { "type": "boolean", "description": "If set to `true`, tags will be pushed to the repository" }, "push_only_tags": { "type": "boolean", "description": "If set to `true`, only tags will be pushed without commits" }, "target_branch": { "type": "string", "description": "The target branch to push to" }, "without_force": { "type": "boolean", "description": "If set to `true`, force push will not be used" }, "isolated": { "type": "boolean", "description": "If set to `true`, the action will run in an isolated environment" }, "use_custom_gitignore": { "type": "boolean", "description": "If set to `true`, custom .gitignore rules will be used" }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "comment": { "type": "string", "description": "The commit message for the push" }, "tag": { "type": "string", "description": "The tag name to create and push" }, "custom_options": { "type": "string", "description": "Custom git push options" }, "targets": { "type": "array", "description": "The list of target repositories to push to", "items": { "$ref": "#/components/schemas/TargetView" } }, "integration": { "$ref": "#/components/schemas/AzureIntegrationRef" }, "push_url": { "type": "string", "description": "The URL of the Azure Git repository to push to" }, "login": { "type": "string", "description": "The username for Azure authentication" }, "env_key": { "type": "string", "description": "The name of the environment variable containing the private key" }, "password": { "type": "string", "description": "The password for Azure authentication" }, "server_key": { "type": "string", "description": "The private SSH key for Azure authentication" }, "git_auth_mode": { "type": "string", "description": "The authentication mode for Git operations", "enum": [ "HTTP", "PRIVATE_KEY", "PUBLIC_BUDDY_KEY", "ENV_KEY", "CURRENT" ] } }, "x-name": "Azure" }, "AzureCliActionRequest": { "required": [ "execute_commands", "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/AzureIntegrationRef" } }, "x-name": "Azure CLI" }, "AzureIntegrationRef": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" } }, "description": "Azure Cloud integration (AZURE_CLOUD)" }, "AzureStorageActionRequest": { "required": [ "bucket_name", "integration", "local_path", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The current git revision" }, "local_path": { "type": "string", "description": "The path to the local files to deploy" }, "remote_path": { "type": "string", "description": "The path on the remote server where files will be deployed" }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "deployment_includes": { "type": "array", "description": "The list of files or directories to include in deployment", "items": { "type": "string", "description": "The list of files or directories to include in deployment" } }, "input_type": { "type": "string", "description": "The type of source input", "enum": [ "SCM_REPOSITORY", "BUILD_ARTIFACTS" ] }, "deletion_disabled": { "type": "boolean", "description": "If set to `true`, files on the remote server will not be deleted" }, "use_temporary_files": { "type": "boolean", "description": "If set to `true`, files will be uploaded to a temporary directory first" }, "content_encoding": { "type": "string", "description": "The content encoding for deployed files" }, "integration": { "$ref": "#/components/schemas/AzureIntegrationRef" }, "application_name": { "type": "string", "description": "The name of the Azure Storage application" }, "bucket_name": { "type": "string", "description": "The name of the Azure Storage container" }, "skip_content_type_setting": { "type": "boolean", "description": "When set to `true`, content type detection will be skipped" } }, "x-name": "Azure Storage" }, "BackblazeB2ActionRequest": { "required": [ "bucket_name", "integration", "local_path", "name", "region", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The current git revision" }, "local_path": { "type": "string", "description": "The path to the local files to deploy" }, "remote_path": { "type": "string", "description": "The path on the remote server where files will be deployed" }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "deployment_includes": { "type": "array", "description": "The list of files or directories to include in deployment", "items": { "type": "string", "description": "The list of files or directories to include in deployment" } }, "input_type": { "type": "string", "description": "The type of source input", "enum": [ "SCM_REPOSITORY", "BUILD_ARTIFACTS" ] }, "deletion_disabled": { "type": "boolean", "description": "If set to `true`, files on the remote server will not be deleted" }, "use_temporary_files": { "type": "boolean", "description": "If set to `true`, files will be uploaded to a temporary directory first" }, "content_encoding": { "type": "string", "description": "The content encoding for deployed files" }, "integration": { "$ref": "#/components/schemas/BackblazeIntegrationRef" }, "bucket_name": { "type": "string", "description": "The name of the Backblaze B2 bucket" }, "cache_control": { "type": "string", "description": "The Cache-Control header value for uploaded files" }, "region": { "type": "string", "description": "The Backblaze B2 region" } }, "x-name": "Backblaze B2" }, "BackblazeIntegrationRef": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" } }, "description": "Backblaze integration (BACKBLAZE)" }, "BinaryFileView": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the binary file" }, "content": { "type": "string", "description": "The base64-encoded content of the binary file" } }, "description": "Key names you want to use to lock your repository" }, "BlackfireGoActionRequest": { "required": [ "execute_commands", "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/BlackfireIntegrationRef" }, "version": { "type": "string", "description": "The version of GO" } }, "x-name": "Blackfire GO" }, "BlackfireIntegrationRef": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" } }, "description": "Blackfire integration (BLACKFIRE)" }, "BlackfirePhpActionRequest": { "required": [ "execute_commands", "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/BlackfireIntegrationRef" }, "version": { "type": "string", "description": "The version of PHP" } }, "x-name": "Blackfire PHP" }, "BlackfirePythonActionRequest": { "required": [ "execute_commands", "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/BlackfireIntegrationRef" }, "version": { "type": "string", "description": "The version of Python" } }, "x-name": "Blackfire Python" }, "BugsnagActionRequest": { "required": [ "name", "release_stage", "token", "type", "version" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "token": { "type": "string", "description": "See `apiKey` [here](https://bugsnagbuildapi.docs.apiary.io/#reference/0/build/notify-of-a-build)" }, "version": { "type": "string", "description": "See `appVersion` [here](https://bugsnagbuildapi.docs.apiary.io/#reference/0/build/notify-of-a-build)" }, "builder_name": { "type": "string", "description": "See `builderName` [here](https://bugsnagbuildapi.docs.apiary.io/#reference/0/build/notify-of-a-build)" }, "release_stage": { "type": "string", "description": "See `releaseStage` [here](https://bugsnagbuildapi.docs.apiary.io/#reference/0/build/notify-of-a-build)" }, "revision": { "type": "string", "description": "See `sourceControl.revision` [here](https://bugsnagbuildapi.docs.apiary.io/#/reference/0/build)" }, "auto_assign_release": { "type": "boolean", "description": "See `autoAssignRelease` [here](https://bugsnagbuildapi.docs.apiary.io/#reference/0/build/notify-of-a-build)" } }, "x-name": "Bugsnag" }, "BuildActionRequest": { "required": [ "docker_image_name", "docker_image_tag", "execute_commands", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "working_directory": { "type": "string", "description": "The directory in which the pipeline filesystem will be mounted" }, "main_service_name": { "type": "string", "description": "The hostname of the container in which the action is run. The container will be available under this name in the docker network for services" }, "run_as_user": { "type": "string", "description": "All build commands are run as the default user defined in the selected Docker image. Can be set to another username (on the condition that this user exists in the selected image)" }, "version": { "type": "string", "description": "The version of the artifact from artifact registry" }, "docker_image_name": { "type": "string", "description": "The name of the Docker image" }, "docker_image_tag": { "type": "string", "description": "The tag of the Docker image" }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "mount_filesystem_disable": { "type": "boolean", "description": "If set to `true`, the filesystem will not be mounted in the container" }, "volume_mappings": { "type": "array", "description": "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)", "items": { "type": "string", "description": "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)" } }, "cached_dirs": { "type": "array", "description": "The dependencies & directories to be cached and available to every execution in this pipeline", "items": { "type": "string", "description": "The dependencies & directories to be cached and available to every execution in this pipeline" } }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "services": { "type": "array", "description": "The list of services attached to the build environment", "items": { "$ref": "#/components/schemas/ServiceView" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "registry": { "type": "string", "description": "The URL of the Docker registry" }, "insecure_registry": { "type": "boolean", "description": "If set to `true`, the registry will be accessed over HTTP instead of HTTPS" }, "login": { "type": "string", "description": "The username for the Docker registry" }, "target_stage": { "type": "string", "description": "The target stage of the Dockerfile" }, "password": { "type": "string", "description": "The password for the Docker registry" }, "region": { "type": "string", "description": "The region for the Docker registry (for AWS ECR)" }, "image_location": { "type": "string", "description": "The location of the image used by the action", "enum": [ "PUBLIC_REGISTRY", "PRIVATE_REGISTRY", "ACTION", "ARTIFACT_REGISTRY" ] }, "use_image_from_action": { "type": "boolean", "description": "If set to `true`, the image from another action will be used" }, "docker_registry": { "type": "string", "description": "The type of registry from which the image is retrieved", "enum": [ "NONE", "DOCKER_HUB", "AMAZON_ECR", "GOOGLE_GCR", "GOOGLE_ARTIFACT_REGISTRY", "OTHER", "GIT_HUB_CONTAINER_REGISTRY", "ARTIFACT_REGISTRY", "DIGITAL_OCEAN_CONTAINER_REGISTRY" ] }, "docker_build_action_id": { "type": "integer", "description": "The ID of the action from which the Docker image will be used", "format": "int32" }, "docker_build_action_name": { "type": "string", "description": "The name of the action from which the Docker image will be used" }, "export_container_path": { "type": "string", "description": "The path in the container to export" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "ignore_image_pull_failures": { "type": "boolean", "description": "If set to `true`, use cached image on timeouts (only for official images)" }, "reset_entrypoint": { "type": "boolean", "description": "If set to `true`, resets the default entrypoint set by the image. Default value: `false`" }, "username": { "type": "string", "description": "The username for authentication" }, "cache_base_image": { "type": "boolean", "description": "If set to `true`, the cached version of the image is used, instead of being pulled each time" }, "do_not_prune_images": { "type": "boolean", "description": "If set to `true`, images will not be pruned after the build" }, "vt_suite": { "type": "string", "description": "The visual tests suite identifier" }, "unit_tests_suite": { "type": "string", "description": "The unit tests suite identifier" }, "unit_tests_path": { "type": "string", "description": "The path to the unit tests results" }, "integration": { "$ref": "#/components/schemas/DockerIntegrationRef" }, "artifact": { "type": "string", "description": "The identifier of the artifact from artifact registry" } }, "x-name": "Custom Build" }, "ClaudeCodeActionRequest": { "required": [ "docker_image_name", "docker_image_tag", "execute_commands", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "working_directory": { "type": "string", "description": "The directory in which the pipeline filesystem will be mounted" }, "main_service_name": { "type": "string", "description": "The hostname of the container in which the action is run. The container will be available under this name in the docker network for services" }, "run_as_user": { "type": "string", "description": "All build commands are run as the default user defined in the selected Docker image. Can be set to another username (on the condition that this user exists in the selected image)" }, "version": { "type": "string", "description": "The version of the artifact from artifact registry" }, "docker_image_name": { "type": "string", "description": "The name of the Docker image" }, "docker_image_tag": { "type": "string", "description": "The tag of the Docker image" }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "mount_filesystem_disable": { "type": "boolean", "description": "If set to `true`, the filesystem will not be mounted in the container" }, "volume_mappings": { "type": "array", "description": "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)", "items": { "type": "string", "description": "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)" } }, "cached_dirs": { "type": "array", "description": "The dependencies & directories to be cached and available to every execution in this pipeline", "items": { "type": "string", "description": "The dependencies & directories to be cached and available to every execution in this pipeline" } }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "services": { "type": "array", "description": "The list of services attached to the build environment", "items": { "$ref": "#/components/schemas/ServiceView" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "registry": { "type": "string", "description": "The URL of the Docker registry" }, "insecure_registry": { "type": "boolean", "description": "If set to `true`, the registry will be accessed over HTTP instead of HTTPS" }, "login": { "type": "string", "description": "The username for the Docker registry" }, "target_stage": { "type": "string", "description": "The target stage of the Dockerfile" }, "password": { "type": "string", "description": "The password for the Docker registry" }, "region": { "type": "string", "description": "The region for the Docker registry (for AWS ECR)" }, "image_location": { "type": "string", "description": "The location of the image used by the action", "enum": [ "PUBLIC_REGISTRY", "PRIVATE_REGISTRY", "ACTION", "ARTIFACT_REGISTRY" ] }, "use_image_from_action": { "type": "boolean", "description": "If set to `true`, the image from another action will be used" }, "docker_registry": { "type": "string", "description": "The type of registry from which the image is retrieved", "enum": [ "NONE", "DOCKER_HUB", "AMAZON_ECR", "GOOGLE_GCR", "GOOGLE_ARTIFACT_REGISTRY", "OTHER", "GIT_HUB_CONTAINER_REGISTRY", "ARTIFACT_REGISTRY", "DIGITAL_OCEAN_CONTAINER_REGISTRY" ] }, "docker_build_action_id": { "type": "integer", "description": "The ID of the action from which the Docker image will be used", "format": "int32" }, "docker_build_action_name": { "type": "string", "description": "The name of the action from which the Docker image will be used" }, "export_container_path": { "type": "string", "description": "The path in the container to export" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "ignore_image_pull_failures": { "type": "boolean", "description": "If set to `true`, use cached image on timeouts (only for official images)" }, "reset_entrypoint": { "type": "boolean", "description": "If set to `true`, resets the default entrypoint set by the image. Default value: `false`" }, "username": { "type": "string", "description": "The username for authentication" }, "cache_base_image": { "type": "boolean", "description": "If set to `true`, the cached version of the image is used, instead of being pulled each time" }, "do_not_prune_images": { "type": "boolean", "description": "If set to `true`, images will not be pruned after the build" }, "vt_suite": { "type": "string", "description": "The visual tests suite identifier" }, "unit_tests_suite": { "type": "string", "description": "The unit tests suite identifier" }, "unit_tests_path": { "type": "string", "description": "The path to the unit tests results" }, "integration": { "$ref": "#/components/schemas/DockerIntegrationRef" }, "prompts": { "type": "array", "description": "List of prompts to send to Claude Code. Each prompt has a `type` (`INLINE` or `FILE`) and a `value`.", "items": { "$ref": "#/components/schemas/LlmBuildPromptView" } }, "model": { "type": "string", "description": "The Claude model to use (e.g. `sonnet`, `opus`, `haiku`)." }, "settings": { "$ref": "#/components/schemas/ClaudeCodeSettingsView" }, "claude_args": { "type": "string", "description": "Additional CLI arguments passed to Claude Code." }, "dangerously_skip_permissions": { "type": "boolean", "description": "If `true`, skip permission prompts (runs with `--dangerously-skip-permissions`)." }, "artifact": { "type": "string", "description": "The identifier of the artifact from artifact registry" } }, "x-name": "Claude Code" }, "ClaudeCodeSettingsView": { "type": "object", "properties": { "type": { "type": "string", "description": "The settings type: `INLINE` or `FILE`." }, "value": { "type": "string", "description": "The settings content (inline JSON) or file path." } }, "description": "JSON string with Claude Code settings." }, "ClearCacheActionRequest": { "required": [ "cache_types", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "cache_types": { "type": "array", "description": "Defines the cache layer cleared by the action", "items": { "type": "string", "description": "Defines the cache layer cleared by the action", "enum": [ "FILE_SYSTEM", "DOCKER", "SERVICES", "ADDITIONAL", "DOCKER_CLI" ] } } }, "x-name": "Clear Cache" }, "CloudFrontInvalidationActionRequest": { "required": [ "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "purge_all": { "type": "boolean", "description": "If set to `true`, all cached content will be purged" }, "purge_by_change_set_limit": { "type": "integer", "description": "The maximum number of files in the changeset to trigger purge", "format": "int32" }, "local_path": { "type": "string", "description": "The path to the local files to invalidate" }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from cache invalidation", "items": { "type": "string", "description": "The list of files or directories to exclude from cache invalidation" } }, "deployment_includes": { "type": "array", "description": "The list of files or directories to include in cache invalidation", "items": { "type": "string", "description": "The list of files or directories to include in cache invalidation" } }, "paths": { "type": "array", "description": "The list of paths to invalidate", "items": { "type": "string", "description": "The list of paths to invalidate" } }, "input_type": { "type": "string", "description": "The type of source input for invalidation (`SCM` or `BUILD_ARTIFACTS`)", "enum": [ "SCM_REPOSITORY", "BUILD_ARTIFACTS" ] }, "integration": { "$ref": "#/components/schemas/AmazonIntegrationRef" }, "distribution_id": { "type": "string", "description": "The ID of the CloudFront web distribution" }, "base_url": { "type": "string", "description": "The base URL for the CloudFront distribution" }, "url_map": { "type": "string", "description": "The URL mapping configuration for invalidation paths" } }, "x-name": "CloudFront" }, "CloudflareIntegrationRef": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" } }, "description": "Cloudflare integration (CLOUDFLARE)" }, "CloudflareInvalidationActionRequest": { "required": [ "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "purge_all": { "type": "boolean", "description": "If set to `true`, all cached content will be purged" }, "purge_by_change_set_limit": { "type": "integer", "description": "The maximum number of files in the changeset to trigger purge", "format": "int32" }, "local_path": { "type": "string", "description": "The path to the local files to invalidate" }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from cache invalidation", "items": { "type": "string", "description": "The list of files or directories to exclude from cache invalidation" } }, "deployment_includes": { "type": "array", "description": "The list of files or directories to include in cache invalidation", "items": { "type": "string", "description": "The list of files or directories to include in cache invalidation" } }, "paths": { "type": "array", "description": "The list of paths to invalidate", "items": { "type": "string", "description": "The list of paths to invalidate" } }, "input_type": { "type": "string", "description": "The type of source input for invalidation (`SCM` or `BUILD_ARTIFACTS`)", "enum": [ "SCM_REPOSITORY", "BUILD_ARTIFACTS" ] }, "integration": { "$ref": "#/components/schemas/CloudflareIntegrationRef" }, "zone": { "type": "string", "description": "The Cloudflare zone name" }, "base_url": { "type": "string", "description": "The base URL for the Cloudflare zone" }, "hosts": { "type": "array", "description": "Hosts specifying objects to invalidate", "items": { "type": "string", "description": "Hosts specifying objects to invalidate" } }, "prefixes": { "type": "array", "description": "Prefixes specifying objects to invalidate", "items": { "type": "string", "description": "Prefixes specifying objects to invalidate" } }, "tags": { "type": "array", "description": "Tags specifying objects to invalidate", "items": { "type": "string", "description": "Tags specifying objects to invalidate" } } }, "x-name": "Cloudflare" }, "CodePipelineActionRequest": { "required": [ "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "integration": { "$ref": "#/components/schemas/AmazonIntegrationRef" }, "code_pipeline_name": { "type": "string", "description": "The name of the AWS CodePipeline pipeline triggered by the action" }, "region": { "type": "string", "description": "The Amazon region" }, "wait_for_complete": { "type": "boolean", "description": "If set to `true`, the action will wait for the CodePipeline to finish" } }, "x-name": "AWS CodePipeline" }, "ContentfulCliActionRequest": { "required": [ "environment", "execute_commands", "integration", "name", "space", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/ContentfulIntegrationRef" }, "space": { "type": "string", "description": "The Contentful space ID where the operations will be performed" }, "environment": { "type": "string", "description": "The ID of the environment" } }, "x-name": "Contentful CLI" }, "ContentfulIntegrationRef": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" } }, "description": "Contentful integration (CONTENTFUL)" }, "CookieView": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the cookie" }, "value": { "type": "string", "description": "The value of the cookie" }, "host": { "type": "string", "description": "The domain for which the cookie is valid" }, "path": { "type": "string", "description": "The path on the server to which the cookie applies" } }, "description": "Set the cookie name/value. Can be given more than once." }, "CopyFilesActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "source_pipeline": { "$ref": "#/components/schemas/PipelineReferenceRequest" }, "target_pipeline": { "$ref": "#/components/schemas/PipelineReferenceRequest" }, "source_path": { "type": "string", "description": "The path in the source pipeline's filesystem" }, "target_path": { "type": "string", "description": "The path in the current pipeline's filesystem" }, "deployment_excludes": { "type": "array", "description": "The paths and/or files that will be left out during the deployment", "items": { "type": "string", "description": "The paths and/or files that will be left out during the deployment" } }, "deployment_includes": { "type": "array", "description": "The exceptions from the ignore patterns set in `deployment_excludes`", "items": { "type": "string", "description": "The exceptions from the ignore patterns set in `deployment_excludes`" } }, "copy_hidden_files": { "type": "boolean", "description": "When set to `true` the hidden files and folders (the ones with the name beginning with a \".\") are copied" }, "delete_extra_files": { "type": "boolean", "description": "When set to `true`, files present in the target but not in the source will be deleted" } }, "x-name": "Copy files" }, "CrawlActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "URL to crawl (optional; defaults to crawl suite URL)" }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "crawl_suite": { "type": "string", "description": "The crawl suite identifier" }, "follow": { "type": "boolean", "description": "Crawl all subviews of the page. Default: false" }, "respect_robots": { "type": "boolean", "description": "Respect robots.txt. Default: false" }, "outputs": { "type": "array", "description": "Output types to produce (type, selector, quality, fullPage)", "items": { "$ref": "#/components/schemas/CrawlOutputView" } }, "browsers": { "type": "array", "description": "Browsers to use (e.g., CHROMIUM, FIREFOX, WEBKIT)", "items": { "type": "string", "description": "Browsers to use (e.g., CHROMIUM, FIREFOX, WEBKIT)" } }, "color_scheme": { "type": "string", "description": "Color scheme to use (LIGHT, DARK, LIGHT_AND_DARK)" }, "delays": { "type": "array", "description": "Add delay in milliseconds before taking screenshot (format: [scope::]milliseconds, e.g., \"1000\" or \"example.com::2000\")", "items": { "type": "string", "description": "Add delay in milliseconds before taking screenshot (format: [scope::]milliseconds, e.g., \"1000\" or \"example.com::2000\")" } }, "wait_for": { "type": "array", "description": "Wait for elements to appear before crawling (format: [scope::]type=value, e.g., \"CSS=#content\" or \"example.com::XPATH=//div[@class='loaded']\")", "items": { "type": "string", "description": "Wait for elements to appear before crawling (format: [scope::]type=value, e.g., \"CSS=#content\" or \"example.com::XPATH=//div[@class='loaded']\")" } }, "local_storage": { "type": "array", "description": "Set localStorage values used when visiting URLs (format: [scope::]key=value)", "items": { "type": "string", "description": "Set localStorage values used when visiting URLs (format: [scope::]key=value)" } }, "devices": { "type": "array", "description": "Device definitions (name, viewport, screen, devicePixelRatio, isMobile)", "items": { "$ref": "#/components/schemas/CrawlDeviceView" } }, "output_directory": { "type": "string", "description": "Output directory for crawl results. Default: \".\"" }, "cookies": { "type": "array", "description": "Set cookies used when visiting the URLs (format: [scope::]cookie_value, e.g., \"session=abc123\" or \"example.com::auth=token123; Path=/; Secure; HttpOnly\")", "items": { "type": "string", "description": "Set cookies used when visiting the URLs (format: [scope::]cookie_value, e.g., \"session=abc123\" or \"example.com::auth=token123; Path=/; Secure; HttpOnly\")" } }, "headers": { "type": "array", "description": "Set HTTP headers used when visiting the URLs (format: [scope::]name=value, e.g., \"Authorization=Bearer token\" or \"example.com::Accept=application/json\")", "items": { "type": "string", "description": "Set HTTP headers used when visiting the URLs (format: [scope::]name=value, e.g., \"Authorization=Bearer token\" or \"example.com::Accept=application/json\")" } } }, "x-name": "Crawl pages" }, "CrawlDeviceView": { "type": "object", "properties": { "name": { "type": "string", "description": "The device name" }, "viewport": { "type": "string", "description": "The viewport size (e.g., 390x844)" }, "screen": { "type": "string", "description": "The screen size (e.g., 390x844)" }, "devicePixelRatio": { "type": "number", "description": "The device pixel ratio", "format": "float" }, "isMobile": { "type": "boolean", "description": "Whether the device is mobile" } }, "description": "Device definitions (name, viewport, screen, devicePixelRatio, isMobile)" }, "CrawlOutputView": { "type": "object", "properties": { "type": { "type": "string", "description": "The output type", "enum": [ "HTML", "MD", "PNG", "JPEG" ] }, "selector": { "$ref": "#/components/schemas/CrawlSelectorView" }, "quality": { "type": "integer", "description": "Image quality (1-100). Applicable to JPEG and PNG", "format": "int32" }, "full_page": { "type": "boolean", "description": "Capture the full page. Default: false" } }, "description": "Output types to produce (type, selector, quality, fullPage)" }, "CrawlSelectorView": { "type": "object", "properties": { "type": { "type": "string", "description": "The selector type", "enum": [ "CSS", "XPATH" ] }, "value": { "type": "string", "description": "The selector expression" } }, "description": "CSS or XPath selector to capture a specific element" }, "CreateSandboxActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "from": { "type": "string", "description": "The source type for creating the sandbox", "enum": [ "SCRATCH", "SANDBOX", "SNAPSHOT" ] }, "sandbox_identifier": { "type": "string", "description": "The identifier of the source sandbox (when creating from another sandbox)" }, "snapshot_name": { "type": "string", "description": "The name of the snapshot (when creating from a snapshot)" }, "update_if_exists": { "type": "boolean", "description": "Whether to update the sandbox configuration if a sandbox with the same identifier already exists in the project. If true and a sandbox exists, it will be reconfigured with the new specification instead of creating a new one" }, "start": { "type": "boolean", "description": "Whether to start the sandbox after creation" }, "spec": { "$ref": "#/components/schemas/SandboxView" } }, "x-name": "Create new sandbox" }, "CustomActionRequest": { "required": [ "custom_type", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "custom_type": { "type": "string", "description": "The type identifier of the custom action" }, "variables_access": { "type": "boolean", "description": "If set to `true`, the custom action has access to pipeline variables" }, "filesystem_access": { "type": "boolean", "description": "If set to `true`, the custom action has access to the pipeline filesystem" }, "inputs": { "type": "array", "description": "The list of input parameters for the custom action", "items": { "$ref": "#/components/schemas/InputView" } } }, "x-name": "Custom Action" }, "CypressActionRequest": { "required": [ "docker_image_name", "docker_image_tag", "execute_commands", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "working_directory": { "type": "string", "description": "The directory in which the pipeline filesystem will be mounted" }, "main_service_name": { "type": "string", "description": "The hostname of the container in which the action is run. The container will be available under this name in the docker network for services" }, "run_as_user": { "type": "string", "description": "All build commands are run as the default user defined in the selected Docker image. Can be set to another username (on the condition that this user exists in the selected image)" }, "version": { "type": "string", "description": "The version of the artifact from artifact registry" }, "docker_image_name": { "type": "string", "description": "The name of the Docker image" }, "docker_image_tag": { "type": "string", "description": "The tag of the Docker image" }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "mount_filesystem_disable": { "type": "boolean", "description": "If set to `true`, the filesystem will not be mounted in the container" }, "volume_mappings": { "type": "array", "description": "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)", "items": { "type": "string", "description": "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)" } }, "cached_dirs": { "type": "array", "description": "The dependencies & directories to be cached and available to every execution in this pipeline", "items": { "type": "string", "description": "The dependencies & directories to be cached and available to every execution in this pipeline" } }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "services": { "type": "array", "description": "The list of services attached to the build environment", "items": { "$ref": "#/components/schemas/ServiceView" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "registry": { "type": "string", "description": "The URL of the Docker registry" }, "insecure_registry": { "type": "boolean", "description": "If set to `true`, the registry will be accessed over HTTP instead of HTTPS" }, "login": { "type": "string", "description": "The username for the Docker registry" }, "target_stage": { "type": "string", "description": "The target stage of the Dockerfile" }, "password": { "type": "string", "description": "The password for the Docker registry" }, "region": { "type": "string", "description": "The region for the Docker registry (for AWS ECR)" }, "image_location": { "type": "string", "description": "The location of the image used by the action", "enum": [ "PUBLIC_REGISTRY", "PRIVATE_REGISTRY", "ACTION", "ARTIFACT_REGISTRY" ] }, "use_image_from_action": { "type": "boolean", "description": "If set to `true`, the image from another action will be used" }, "docker_registry": { "type": "string", "description": "The type of registry from which the image is retrieved", "enum": [ "NONE", "DOCKER_HUB", "AMAZON_ECR", "GOOGLE_GCR", "GOOGLE_ARTIFACT_REGISTRY", "OTHER", "GIT_HUB_CONTAINER_REGISTRY", "ARTIFACT_REGISTRY", "DIGITAL_OCEAN_CONTAINER_REGISTRY" ] }, "docker_build_action_id": { "type": "integer", "description": "The ID of the action from which the Docker image will be used", "format": "int32" }, "docker_build_action_name": { "type": "string", "description": "The name of the action from which the Docker image will be used" }, "export_container_path": { "type": "string", "description": "The path in the container to export" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "ignore_image_pull_failures": { "type": "boolean", "description": "If set to `true`, use cached image on timeouts (only for official images)" }, "reset_entrypoint": { "type": "boolean", "description": "If set to `true`, resets the default entrypoint set by the image. Default value: `false`" }, "username": { "type": "string", "description": "The username for authentication" }, "cache_base_image": { "type": "boolean", "description": "If set to `true`, the cached version of the image is used, instead of being pulled each time" }, "do_not_prune_images": { "type": "boolean", "description": "If set to `true`, images will not be pruned after the build" }, "vt_suite": { "type": "string", "description": "The visual tests suite identifier" }, "unit_tests_suite": { "type": "string", "description": "The unit tests suite identifier" }, "unit_tests_path": { "type": "string", "description": "The path to the unit tests results" }, "integration": { "$ref": "#/components/schemas/DockerIntegrationRef" }, "artifact": { "type": "string", "description": "The identifier of the artifact from artifact registry" } }, "x-name": "Cypress" }, "DatadogActionRequest": { "required": [ "alert_type", "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "integration": { "$ref": "#/components/schemas/DatadogIntegrationRef" }, "content": { "type": "string", "description": "The content of the posted event" }, "title": { "type": "string", "description": "The title of the posted event" }, "host": { "type": "string", "description": "The Host name to associate with the event. Any tags associated with the host will also be applied to this event" }, "tags": { "uniqueItems": true, "type": "array", "description": "The list of tags to apply to the event", "items": { "type": "string", "description": "The list of tags to apply to the event" } }, "alert_type": { "type": "string", "description": "The type of the alert. Can be one of `SUCCESS`, `WARNING` or `ERROR`" }, "aggregation_key": { "type": "string", "description": "An arbitrary string to use for aggregation, max length of 100 characters. If you specify a key, all events using that key will be grouped together in the Event Stream" }, "region": { "type": "string", "description": "The Datadog region. Can be one of `US1`, `US3`, `US5`, `EU1`, `AP1`, `US1_FED`. If not set, the default is `US1`" } }, "x-name": "Datadog notification" }, "DatadogIntegrationRef": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" } }, "description": "Datadog integration (DATADOG)" }, "DatadogStatusCheckActionRequest": { "required": [ "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "integration": { "$ref": "#/components/schemas/DatadogIntegrationRef" }, "message": { "type": "string", "description": "A description of why this status occurred" }, "check": { "type": "string", "description": "The text for the message" }, "host_name": { "type": "string", "description": "The Host name to associate with the event. Any tags associated with the host will also be applied to this event" }, "status": { "type": "integer", "description": "An integer for the status of the check", "format": "int32" }, "region": { "type": "string", "description": "The Datadog region. Can be one of `US1`, `US3`, `US5`, `EU1`, `AP1`, `US1_FED`. If not set, the default is `US1`" } }, "x-name": "Datadog Service Check" }, "DeployToSandboxActionRequest": { "required": [ "input_type", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "sandbox_id": { "type": "string", "description": "The ID of the sandbox" }, "sandbox_references": { "uniqueItems": true, "type": "array", "description": "The set of sandbox reference types", "items": { "type": "string", "description": "The set of sandbox reference types", "enum": [ "BY_ID", "BY_TAGS", "BY_ACTION", "BY_NAME", "BY_PROJECT", "BY_DAYS" ] } }, "sandbox_project_id": { "type": "integer", "description": "The ID of the sandbox project", "format": "int32" }, "sandbox_project_name": { "type": "string", "description": "The name of the sandbox project" }, "tags": { "uniqueItems": true, "type": "array", "description": "The set of tags for the sandbox", "items": { "type": "string", "description": "The set of tags for the sandbox" } }, "referenced_sandbox_name": { "type": "string", "description": "The name of the referenced sandbox" }, "days": { "type": "integer", "description": "The number of days for sandbox retention", "format": "int32" }, "referenced_action_id": { "type": "integer", "description": "The ID of the referenced action", "format": "int32" }, "referenced_action_name": { "type": "string", "description": "The name of the referenced action" }, "local_path": { "type": "string", "description": "The local path to the files to deploy" }, "remote_path": { "type": "string", "description": "The remote path in the sandbox where files will be deployed" }, "user": { "type": "string", "description": "The user account to use for deployment" }, "deployment_excludes": { "type": "array", "description": "The list of file patterns to exclude from deployment", "items": { "type": "string", "description": "The list of file patterns to exclude from deployment" } }, "deployment_includes": { "type": "array", "description": "The list of file patterns to include in deployment", "items": { "type": "string", "description": "The list of file patterns to include in deployment" } }, "input_type": { "type": "string", "description": "The type of input source (`SCM` or `BUILD_ARTIFACTS`)", "enum": [ "SCM_REPOSITORY", "BUILD_ARTIFACTS" ] }, "deletion_disabled": { "type": "boolean", "description": "If set to `true`, files in the target directory that don't exist in the source won't be deleted" }, "use_temporary_files": { "type": "boolean", "description": "If set to `true`, temporary files will be used during deployment" } }, "description": "This action type is deprecated. Please use alternative sandbox management actions.", "deprecated": true, "x-name": "Deploy to Sandbox" }, "DeploymentTagView": { "type": "object", "properties": { "key": { "type": "string", "description": "The key/name of the deployment tag" }, "value": { "type": "string", "description": "The value of the deployment tag" } }, "description": "Defines tags for files categorization as a key value pairs list" }, "DigitalOceanCdnInvalidationActionRequest": { "required": [ "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "purge_all": { "type": "boolean", "description": "If set to `true`, all cached content will be purged" }, "purge_by_change_set_limit": { "type": "integer", "description": "The maximum number of files in the changeset to trigger purge", "format": "int32" }, "local_path": { "type": "string", "description": "The path to the local files to invalidate" }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from cache invalidation", "items": { "type": "string", "description": "The list of files or directories to exclude from cache invalidation" } }, "deployment_includes": { "type": "array", "description": "The list of files or directories to include in cache invalidation", "items": { "type": "string", "description": "The list of files or directories to include in cache invalidation" } }, "paths": { "type": "array", "description": "The list of paths to invalidate", "items": { "type": "string", "description": "The list of paths to invalidate" } }, "input_type": { "type": "string", "description": "The type of source input for invalidation (`SCM` or `BUILD_ARTIFACTS`)", "enum": [ "SCM_REPOSITORY", "BUILD_ARTIFACTS" ] }, "integration": { "$ref": "#/components/schemas/DigitalOceanIntegrationRef" }, "endpoint": { "type": "string", "description": "The ID of the DigitalOcean CDN web distribution" }, "remote_path": { "type": "string", "description": "The path to invalidate in the CDN cache" } }, "x-name": "DigitalOcean CDN" }, "DigitalOceanIntegrationRef": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" } }, "description": "DigitalOcean integration (DIGITAL_OCEAN)" }, "DiscordActionRequest": { "required": [ "name", "notification_url", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "notification_url": { "type": "string", "description": "The URL do the desired Discord [webhook](https://discordapp.com/developers/docs/resources/webhook#execute-webhook)" }, "content": { "type": "string", "description": "The content of the notification" }, "attachments": { "type": "array", "description": "The embedded rich content. More info [here](https://discordapp.com/developers/docs/resources/channel#attachment-object-attachment-structure)", "items": { "type": "string", "description": "The embedded rich content. More info [here](https://discordapp.com/developers/docs/resources/channel#attachment-object-attachment-structure)" } }, "file_attachments": { "type": "array", "description": "The attached files", "items": { "type": "string", "description": "The attached files" } } }, "x-name": "Discord notification" }, "DoSpacesActionRequest": { "required": [ "bucket_name", "integration", "local_path", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The current git revision" }, "local_path": { "type": "string", "description": "The path to the local files to deploy" }, "remote_path": { "type": "string", "description": "The path on the remote server where files will be deployed" }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "deployment_includes": { "type": "array", "description": "The list of files or directories to include in deployment", "items": { "type": "string", "description": "The list of files or directories to include in deployment" } }, "input_type": { "type": "string", "description": "The type of source input", "enum": [ "SCM_REPOSITORY", "BUILD_ARTIFACTS" ] }, "deletion_disabled": { "type": "boolean", "description": "If set to `true`, files on the remote server will not be deleted" }, "use_temporary_files": { "type": "boolean", "description": "If set to `true`, files will be uploaded to a temporary directory first" }, "content_encoding": { "type": "string", "description": "The content encoding for deployed files" }, "integration": { "$ref": "#/components/schemas/DoSpacesIntegrationRef" }, "bucket_name": { "type": "string", "description": "The name of the DigitalOcean Spaces bucket" }, "public_access": { "type": "boolean", "description": "If set to `true`, uploaded files will have public read access" }, "cache_control": { "type": "string", "description": "The Cache-Control header value for uploaded files" }, "region": { "type": "string", "description": "The DigitalOcean Spaces region" } }, "x-name": "DigitalOcean Spaces" }, "DoSpacesIntegrationRef": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" } }, "description": "DigitalOcean Spaces integration (DO_SPACES)" }, "DockerBuildMultiArchActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "docker_image_tag": { "type": "string", "description": "The tag of the Docker image" }, "repository": { "type": "string", "description": "The name of the Docker repository" }, "registry": { "type": "string", "description": "The URL of the Docker registry" }, "insecure_registry": { "type": "boolean", "description": "If set to `true`, the registry will be accessed over HTTP instead of HTTPS" }, "region": { "type": "string", "description": "The region for the Docker registry (for AWS ECR)" }, "login": { "type": "string", "description": "The username for the Docker registry" }, "password": { "type": "string", "description": "The password for the Docker registry" }, "target_stage": { "type": "string", "description": "The target stage of the Dockerfile" }, "do_not_prune_images": { "type": "boolean", "description": "If set to `true`, images will not be pruned after the build" }, "versions": { "type": "array", "description": "The list of image versions to build or push", "items": { "type": "string", "description": "The list of image versions to build or push" } }, "docker_registry": { "type": "string", "description": "The type of registry from which the image is retrieved", "enum": [ "NONE", "DOCKER_HUB", "AMAZON_ECR", "GOOGLE_GCR", "GOOGLE_ARTIFACT_REGISTRY", "OTHER", "GIT_HUB_CONTAINER_REGISTRY", "ARTIFACT_REGISTRY", "DIGITAL_OCEAN_CONTAINER_REGISTRY" ] }, "target_platform": { "type": "string", "description": "The target platform for the Docker build" }, "cache_mode": { "type": "string", "description": "The caching mode for Docker build", "enum": [ "MIN", "MAX" ] }, "pull": { "type": "boolean", "description": "If set to `false`, the image will not be pulled before building" }, "target_path": { "type": "string", "description": "The target path in the container" }, "use_image_from_action": { "type": "boolean", "description": "If set to `true`, the image from another action will be used" }, "docker_build_action_id": { "type": "integer", "description": "The ID of the action from which the Docker image will be used", "format": "int32" }, "docker_build_action_name": { "type": "string", "description": "The name of the action from which the Docker image will be used" }, "image_location": { "type": "string", "description": "The location of the image used by the action", "enum": [ "PUBLIC_REGISTRY", "PRIVATE_REGISTRY", "ACTION", "ARTIFACT_REGISTRY" ] }, "dockerfile_path": { "type": "string", "description": "The path to the Dockerfile" }, "context_path": { "type": "string", "description": "The path to the Docker build context" }, "provenance": { "type": "string", "description": "The provenance attestation mode for the build", "enum": [ "NONE", "MIN", "MAX" ] }, "build_args": { "type": "array", "description": "The list of build arguments to pass to the Docker build", "items": { "type": "string", "description": "The list of build arguments to pass to the Docker build" } }, "secrets": { "type": "array", "description": "The list of secrets to pass to the Docker build", "items": { "$ref": "#/components/schemas/DockerSecretView" } }, "integration": { "$ref": "#/components/schemas/DockerIntegrationRef" }, "artifact": { "type": "string", "description": "The identifier of the artifact from artifact registry" } }, "x-name": "Build multi-arch image" }, "DockerCliActionRequest": { "required": [ "execute_commands", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/DockerIntegrationRef" }, "registry": { "type": "string", "description": "The Docker registry URL" }, "region": { "type": "string", "description": "The region for cloud-based Docker registries" }, "login": { "type": "string", "description": "The login username for Docker registry authentication" }, "password": { "type": "string", "description": "The password for Docker registry authentication" } }, "x-name": "Docker CLI" }, "DockerCliNativeBuildActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "working_directory": { "type": "string", "description": "The directory in which the pipeline filesystem will be mounted" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "commands": { "type": "array", "description": "The commands to execute in the native build environment", "items": { "type": "string", "description": "The commands to execute in the native build environment" } }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "vm_from_prev_action": { "type": "boolean", "description": "If set to `true`, the VM from the previous action will be used" }, "vm_action_id": { "type": "integer", "description": "The ID of the action from which the VM will be used", "format": "int32" }, "vm_action_name": { "type": "string", "description": "The name of the action from which the VM will be used" }, "instance_type": { "type": "string", "description": "The type of instance to use for the native build", "enum": [ "GENERAL_MEDIUM", "GENERAL_LARGE", "GENERAL_XLARGE", "GENERAL_2XLARGE", "COMPUTE_MEDIUM", "COMPUTE_LARGE", "COMPUTE_XLARGE", "COMPUTE_2XLARGE", "ARM_GENERAL_MEDIUM", "ARM_GENERAL_LARGE", "ARM_GENERAL_XLARGE", "ARM_GENERAL_2XLARGE", "ARM_COMPUTE_MEDIUM", "ARM_COMPUTE_LARGE", "ARM_COMPUTE_XLARGE", "ARM_COMPUTE_2XLARGE" ] }, "sync_paths": { "type": "array", "description": "File paths that should be copied before (`PIPELINE_TO_VM`) and after the execution (`VM_TO_PIPELINE`)", "items": { "$ref": "#/components/schemas/SyncPathView" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "distribution": { "type": "string", "description": "The AWS distribution type for the Docker native build", "enum": [ "UBUNTU_20_04", "AMI", "WINDOWS_SERVER_2019", "PREVIOUS_ACTION" ] }, "ami": { "$ref": "#/components/schemas/AmiView" } }, "x-name": "Docker CLI in VM" }, "DockerIntegrationRef": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" } }, "description": "Docker registry integration (DOCKER_HUB|GOOGLE_SERVICE_ACCOUNT|AMAZON|GIT_HUB|GIT_HUB_ENTERPRISE)" }, "DockerPushActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "docker_image_tag": { "type": "string", "description": "The tag of the Docker image" }, "repository": { "type": "string", "description": "The name of the Docker repository" }, "registry": { "type": "string", "description": "The URL of the Docker registry" }, "insecure_registry": { "type": "boolean", "description": "If set to `true`, the registry will be accessed over HTTP instead of HTTPS" }, "region": { "type": "string", "description": "The region for the Docker registry (for AWS ECR)" }, "login": { "type": "string", "description": "The username for the Docker registry" }, "password": { "type": "string", "description": "The password for the Docker registry" }, "target_stage": { "type": "string", "description": "The target stage of the Dockerfile" }, "do_not_prune_images": { "type": "boolean", "description": "If set to `true`, images will not be pruned after the build" }, "versions": { "type": "array", "description": "The list of image versions to build or push", "items": { "type": "string", "description": "The list of image versions to build or push" } }, "docker_registry": { "type": "string", "description": "The type of registry from which the image is retrieved", "enum": [ "NONE", "DOCKER_HUB", "AMAZON_ECR", "GOOGLE_GCR", "GOOGLE_ARTIFACT_REGISTRY", "OTHER", "GIT_HUB_CONTAINER_REGISTRY", "ARTIFACT_REGISTRY", "DIGITAL_OCEAN_CONTAINER_REGISTRY" ] }, "target_platform": { "type": "string", "description": "The target platform for the Docker build" }, "cache_mode": { "type": "string", "description": "The caching mode for Docker build", "enum": [ "MIN", "MAX" ] }, "pull": { "type": "boolean", "description": "If set to `false`, the image will not be pulled before building" }, "target_path": { "type": "string", "description": "The target path in the container" }, "use_image_from_action": { "type": "boolean", "description": "If set to `true`, the image from another action will be used" }, "docker_build_action_id": { "type": "integer", "description": "The ID of the action from which the Docker image will be used", "format": "int32" }, "docker_build_action_name": { "type": "string", "description": "The name of the action from which the Docker image will be used" }, "image_location": { "type": "string", "description": "The location of the image used by the action", "enum": [ "PUBLIC_REGISTRY", "PRIVATE_REGISTRY", "ACTION", "ARTIFACT_REGISTRY" ] }, "integration": { "$ref": "#/components/schemas/DockerIntegrationRef" }, "artifact": { "type": "string", "description": "The identifier of the artifact from artifact registry" } }, "x-name": "Push Docker Image" }, "DockerSecretView": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the secret" }, "value": { "type": "string", "description": "The value of the secret" }, "type": { "type": "string", "description": "The type of the secret", "enum": [ "FILE", "ENV" ] } }, "description": "The list of secrets to pass to the Docker build" }, "DockerfileActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "docker_image_tag": { "type": "string", "description": "The tag of the Docker image" }, "repository": { "type": "string", "description": "The name of the Docker repository" }, "registry": { "type": "string", "description": "The URL of the Docker registry" }, "insecure_registry": { "type": "boolean", "description": "If set to `true`, the registry will be accessed over HTTP instead of HTTPS" }, "region": { "type": "string", "description": "The region for the Docker registry (for AWS ECR)" }, "login": { "type": "string", "description": "The username for the Docker registry" }, "password": { "type": "string", "description": "The password for the Docker registry" }, "target_stage": { "type": "string", "description": "The target stage of the Dockerfile" }, "do_not_prune_images": { "type": "boolean", "description": "If set to `true`, images will not be pruned after the build" }, "versions": { "type": "array", "description": "The list of image versions to build or push", "items": { "type": "string", "description": "The list of image versions to build or push" } }, "docker_registry": { "type": "string", "description": "The type of registry from which the image is retrieved", "enum": [ "NONE", "DOCKER_HUB", "AMAZON_ECR", "GOOGLE_GCR", "GOOGLE_ARTIFACT_REGISTRY", "OTHER", "GIT_HUB_CONTAINER_REGISTRY", "ARTIFACT_REGISTRY", "DIGITAL_OCEAN_CONTAINER_REGISTRY" ] }, "target_platform": { "type": "string", "description": "The target platform for the Docker build" }, "cache_mode": { "type": "string", "description": "The caching mode for Docker build", "enum": [ "MIN", "MAX" ] }, "pull": { "type": "boolean", "description": "If set to `false`, the image will not be pulled before building" }, "target_path": { "type": "string", "description": "The target path in the container" }, "use_image_from_action": { "type": "boolean", "description": "If set to `true`, the image from another action will be used" }, "docker_build_action_id": { "type": "integer", "description": "The ID of the action from which the Docker image will be used", "format": "int32" }, "docker_build_action_name": { "type": "string", "description": "The name of the action from which the Docker image will be used" }, "image_location": { "type": "string", "description": "The location of the image used by the action", "enum": [ "PUBLIC_REGISTRY", "PRIVATE_REGISTRY", "ACTION", "ARTIFACT_REGISTRY" ] }, "dockerfile_path": { "type": "string", "description": "The path to the Dockerfile" }, "context_path": { "type": "string", "description": "The path to the Docker build context" }, "provenance": { "type": "string", "description": "The provenance attestation mode for the build", "enum": [ "NONE", "MIN", "MAX" ] }, "build_args": { "type": "array", "description": "The list of build arguments to pass to the Docker build", "items": { "type": "string", "description": "The list of build arguments to pass to the Docker build" } }, "secrets": { "type": "array", "description": "The list of secrets to pass to the Docker build", "items": { "$ref": "#/components/schemas/DockerSecretView" } }, "integration": { "$ref": "#/components/schemas/DockerIntegrationRef" }, "artifact": { "type": "string", "description": "The identifier of the artifact from artifact registry" } }, "x-name": "Build Docker Image" }, "DockerfileLinterActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "local_path": { "type": "string", "description": "The path to the Dockerfile to lint" }, "shell_type": { "type": "string", "description": "The shell type to use for linting (e.g., `bash`, `sh`)" }, "ignore_codes": { "type": "string", "description": "Comma-separated list of rule codes to ignore during linting" }, "ignores_path": { "type": "string", "description": "The path to a file containing rules to ignore" } }, "x-name": "Dockerfile Linter" }, "DoctlActionRequest": { "required": [ "execute_commands", "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/DigitalOceanIntegrationRef" } }, "x-name": "DigitalOcean CLI" }, "DownloadArtifactActionRequest": { "required": [ "destination_path", "name", "source_path", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "source_path": { "type": "string", "description": "The path to the source file or directory to download" }, "destination_path": { "type": "string", "description": "The path where the downloaded files will be saved" }, "recursive": { "type": "boolean", "description": "If set to `true`, directories will be downloaded recursively" }, "overwrite": { "type": "boolean", "description": "If set to `true`, existing files will be overwritten" }, "download_excludes": { "type": "array", "description": "The list of files or directories to exclude from download", "items": { "type": "string", "description": "The list of files or directories to exclude from download" } }, "download_includes": { "type": "array", "description": "The list of files or directories to include in download", "items": { "type": "string", "description": "The list of files or directories to include in download" } }, "version": { "type": "string", "description": "The version of the artifact from artifact registry" }, "artifact": { "type": "string", "description": "The identifier of the artifact from artifact registry" } }, "x-name": "Download Artifact Version" }, "DownloadBackblazeActionRequest": { "required": [ "destination_path", "integration", "name", "source_path", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "source_path": { "type": "string", "description": "The path to the source file or directory to download" }, "destination_path": { "type": "string", "description": "The path where the downloaded files will be saved" }, "recursive": { "type": "boolean", "description": "If set to `true`, directories will be downloaded recursively" }, "overwrite": { "type": "boolean", "description": "If set to `true`, existing files will be overwritten" }, "download_excludes": { "type": "array", "description": "The list of files or directories to exclude from download", "items": { "type": "string", "description": "The list of files or directories to exclude from download" } }, "download_includes": { "type": "array", "description": "The list of files or directories to include in download", "items": { "type": "string", "description": "The list of files or directories to include in download" } }, "integration": { "$ref": "#/components/schemas/BackblazeIntegrationRef" }, "bucket_name": { "type": "string", "description": "The name of the Backblaze B2 bucket" }, "region": { "type": "string", "description": "The Backblaze B2 region" } }, "x-name": "Download Backblaze B2" }, "DownloadFromGcsActionRequest": { "required": [ "destination_path", "integration", "name", "source_path", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "source_path": { "type": "string", "description": "The path to the source file or directory to download" }, "destination_path": { "type": "string", "description": "The path where the downloaded files will be saved" }, "recursive": { "type": "boolean", "description": "If set to `true`, directories will be downloaded recursively" }, "overwrite": { "type": "boolean", "description": "If set to `true`, existing files will be overwritten" }, "download_excludes": { "type": "array", "description": "The list of files or directories to exclude from download", "items": { "type": "string", "description": "The list of files or directories to exclude from download" } }, "download_includes": { "type": "array", "description": "The list of files or directories to include in download", "items": { "type": "string", "description": "The list of files or directories to include in download" } }, "integration": { "$ref": "#/components/schemas/GoogleServiceAccountIntegrationRef" }, "bucket_name": { "type": "string", "description": "The name of the Google Cloud Storage bucket to download from" }, "application_name": { "type": "string", "description": "The name of the GCS application" } }, "x-name": "Download GCS" }, "DownloadFromSandboxActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "sandbox_id": { "type": "string", "description": "The ID of the sandbox" }, "sandbox_references": { "uniqueItems": true, "type": "array", "description": "The set of sandbox reference types", "items": { "type": "string", "description": "The set of sandbox reference types", "enum": [ "BY_ID", "BY_TAGS", "BY_ACTION", "BY_NAME", "BY_PROJECT", "BY_DAYS" ] } }, "sandbox_project_id": { "type": "integer", "description": "The ID of the sandbox project", "format": "int32" }, "sandbox_project_name": { "type": "string", "description": "The name of the sandbox project" }, "tags": { "uniqueItems": true, "type": "array", "description": "The set of tags for the sandbox", "items": { "type": "string", "description": "The set of tags for the sandbox" } }, "referenced_sandbox_name": { "type": "string", "description": "The name of the referenced sandbox" }, "days": { "type": "integer", "description": "The number of days for sandbox retention", "format": "int32" }, "referenced_action_id": { "type": "integer", "description": "The ID of the referenced action", "format": "int32" }, "referenced_action_name": { "type": "string", "description": "The name of the referenced action" }, "source_path": { "type": "string", "description": "The path in the sandbox to download from" }, "destination_path": { "type": "string", "description": "The local destination path for downloaded files" }, "recursive": { "type": "boolean", "description": "If set to `true`, downloads directories recursively" }, "overwrite": { "type": "boolean", "description": "If set to `true`, existing local files will be overwritten" }, "download_excludes": { "type": "array", "description": "The list of file patterns to exclude from download", "items": { "type": "string", "description": "The list of file patterns to exclude from download" } }, "download_includes": { "type": "array", "description": "The list of file patterns to include in download", "items": { "type": "string", "description": "The list of file patterns to include in download" } }, "user": { "type": "string", "description": "The user account to use for download operations" } }, "description": "This action type is deprecated. Please use alternative sandbox management actions.", "deprecated": true, "x-name": "Download from Sandbox" }, "DownloadFtpActionRequest": { "required": [ "destination_path", "name", "source_path", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "source_path": { "type": "string", "description": "The path to the source file or directory to download" }, "destination_path": { "type": "string", "description": "The path where the downloaded files will be saved" }, "recursive": { "type": "boolean", "description": "If set to `true`, directories will be downloaded recursively" }, "overwrite": { "type": "boolean", "description": "If set to `true`, existing files will be overwritten" }, "download_excludes": { "type": "array", "description": "The list of files or directories to exclude from download", "items": { "type": "string", "description": "The list of files or directories to exclude from download" } }, "download_includes": { "type": "array", "description": "The list of files or directories to include in download", "items": { "type": "string", "description": "The list of files or directories to include in download" } }, "targets": { "type": "array", "description": "The list of FTP server targets", "items": { "$ref": "#/components/schemas/TargetView" } } }, "x-name": "Download" }, "DownloadS3ActionRequest": { "required": [ "bucket_name", "destination_path", "integration", "name", "source_path", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "source_path": { "type": "string", "description": "The path to the source file or directory to download" }, "destination_path": { "type": "string", "description": "The path where the downloaded files will be saved" }, "recursive": { "type": "boolean", "description": "If set to `true`, directories will be downloaded recursively" }, "overwrite": { "type": "boolean", "description": "If set to `true`, existing files will be overwritten" }, "download_excludes": { "type": "array", "description": "The list of files or directories to exclude from download", "items": { "type": "string", "description": "The list of files or directories to exclude from download" } }, "download_includes": { "type": "array", "description": "The list of files or directories to include in download", "items": { "type": "string", "description": "The list of files or directories to include in download" } }, "integration": { "$ref": "#/components/schemas/AmazonIntegrationRef" }, "bucket_name": { "type": "string", "description": "The name of the Amazon S3 Bucket" } }, "x-name": "Download S3" }, "EmailActionRequest": { "required": [ "content", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "title": { "type": "string", "description": "The title of the notification" }, "content": { "type": "string", "description": "The content of the notification" }, "recipients": { "type": "string", "description": "The recipients of the notification: email addresses (one per line). One of `send_to_groups` or `recipients` must be specified" }, "send_to_groups": { "type": "array", "description": "The list of groups' names to which emails will be sent. One of `send_to_groups` or `recipients` must be specified", "items": { "type": "string", "description": "The list of groups' names to which emails will be sent. One of `send_to_groups` or `recipients` must be specified" } }, "send_as_html": { "type": "boolean", "description": "Defines whether to send the content as HTML" }, "from_name": { "type": "string", "description": "The e-mail sender name" }, "file_attachments": { "type": "array", "description": "The attached files", "items": { "type": "string", "description": "The attached files" } } }, "x-name": "Email notification" }, "EnvironmentVariableView": { "type": "object", "properties": { "id": { "type": "integer", "description": "The ID of the variable", "format": "int32" }, "key": { "type": "string", "description": "The name of the variable" }, "value": { "type": "string", "description": "The value of the variable" }, "type": { "type": "string", "description": "The type of the added variable", "enum": [ "VAR", "FILE", "SSH_KEY", "IOS_KEYCHAIN", "IOS_PROVISION_PROFILES", "SSH_PUBLIC_KEY", "GPG_KEY" ] }, "encrypted": { "type": "boolean", "description": "If set to `true` the variable value will be encrypted and hidden" }, "settable": { "type": "boolean", "description": "If set to `true` the variable value can be set by Buddy actions" }, "run_only_settable": { "type": "boolean", "description": "Available only if `type=VAR`. If set to `true` the variable value can be set by Buddy actions only for execution time" }, "description": { "type": "string", "description": "The optional description of the variable" }, "init_path": { "type": "string", "description": "Initial path for the variable" }, "defaults": { "type": "string", "description": "Default value for the variable" }, "file_path": { "type": "string", "description": "Specifies where to copy the file on each run. Set if `type` is `FILE`, `SSH_KEY`, `SSH_PUBLIC_KEY`, `IOS_KEYCHAIN`, or `IOS_PROVISION_PROFILES`" }, "file_chmod": { "type": "string", "description": "File permission set on copy to a container on each run. Set if `type` is `FILE`, `SSH_KEY`, `SSH_PUBLIC_KEY`, `IOS_KEYCHAIN`, or `IOS_PROVISION_PROFILES`" }, "file_place": { "type": "string", "description": "Set if `type` is `FILE`, `SSH_KEY`, `SSH_PUBLIC_KEY`, `IOS_KEYCHAIN`, or `IOS_PROVISION_PROFILES`. If it's `NONE`, the variable can be used as a parameter in an action. For `CONTAINER`, the given key is additionally copied to an action container on each run", "enum": [ "NONE", "CONTAINER" ] }, "binary": { "type": "boolean", "description": "Whether the file is binary" }, "public_value": { "type": "string", "description": "Public value for SSH key type variables" }, "key_fingerprint": { "type": "string", "description": "Fingerprint of SSH key" }, "checksum": { "type": "string", "description": "Checksum of the variable value" }, "password": { "type": "string", "description": "Password for certificates" }, "passphrase": { "type": "string", "description": "Passphrase for encrypted SSH keys" }, "key_identifier": { "type": "string", "description": "Key identifier for iOS certificates, provisioning profiles, or GPG keys" }, "disabled": { "type": "boolean", "description": "Set to `true` to disable the variable. Disabled variables are not injected anywhere" } }, "description": "The list of variables you can use the action" }, "EslintActionRequest": { "required": [ "name", "style", "type", "version" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "local_path": { "type": "string", "description": "The path in the repository" }, "style": { "type": "string", "description": "The name of the code style. Can be one of `airbnb`, `canonical`, `canonical/ava`, `canonical/flowtype`, `canonical/jest`, `canonical/lodash`, `canonical/mocha`, `canonical/react`, `eslint`, `es/2015/server`, `es/2015/client`, `facebook`, `google`, `standard`, `xo`, `xo/esnext`, `xo/browser` or `custom`" }, "version": { "type": "string", "description": "The version of the NodeJS" }, "build_tool_version": { "type": "string", "description": "The version of the build tools" }, "fix": { "type": "boolean", "description": "Defines whether to automatically fix code issues or just perform the code analysis" }, "quiet": { "type": "boolean", "description": "When set to `true`, reports only errors, without warnings" }, "config_path": { "type": "string", "description": "Required if `style` is set to `custom`. Path to the style config file" } }, "description": "This action type is deprecated. Please use BUILD action with ESLint commands instead.", "deprecated": true, "x-name": "Eslint" }, "ExcludedAreaView": { "type": "object", "properties": { "min_x": { "type": "integer", "description": "The minimum X coordinate of the excluded area", "format": "int32" }, "min_y": { "type": "integer", "description": "The minimum Y coordinate of the excluded area", "format": "int32" }, "max_x": { "type": "integer", "description": "The maximum X coordinate of the excluded area", "format": "int32" }, "max_y": { "type": "integer", "description": "The maximum Y coordinate of the excluded area", "format": "int32" } }, "description": "The list of areas to exclude from visual comparison" }, "FastlaneAndroidActionRequest": { "required": [ "execute_commands", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "build_tool_version": { "type": "string", "description": "The version of the Android Build Tools" } }, "x-name": "Build Android App" }, "FirebaseActionRequest": { "required": [ "application_id", "execute_commands", "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "integration": { "$ref": "#/components/schemas/FirebaseIntegrationRef" }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "working_directory": { "type": "string", "description": "The directory in which the commands are executed. Available when `type` is set to `CUSTOM`" }, "mount_filesystem_disable": { "type": "boolean", "description": "Defines whether or not to mount the filesystem to the running container" }, "volume_mappings": { "type": "array", "description": "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)", "items": { "type": "string", "description": "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)" } }, "execute_commands": { "type": "array", "description": "Commands that will be executed", "items": { "type": "string", "description": "Commands that will be executed" } }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "application_id": { "type": "string", "description": "The ID of the Firebase application" }, "build_tool_version": { "type": "string", "description": "The version of the build tools" }, "version": { "type": "string", "description": "The version of the Firebase CLI" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" } }, "x-name": "Firebase" }, "FirebaseIntegrationRef": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" } }, "description": "Firebase integration (FIREBASE)" }, "GcloudCliActionRequest": { "required": [ "execute_commands", "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/GoogleServiceAccountIntegrationRef" }, "application_name": { "type": "string", "description": "The name of the Google application" }, "server_key": { "type": "string", "description": "The private SSH key" }, "env_key": { "type": "string", "description": "The private SSH key name defined in environment variables" }, "version": { "type": "string", "description": "The version of Google Cloud CLI to use. Defaults to `latest`" } }, "deprecated": true, "x-name": "GCloud CLI" }, "GcloudRunDeployActionRequest": { "required": [ "integration", "name", "server_key", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "integration": { "$ref": "#/components/schemas/GoogleServiceAccountIntegrationRef" }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "application_name": { "type": "string", "description": "The name of the application" }, "server_key": { "type": "string", "description": "The private SSH key" }, "env_key": { "type": "string", "description": "The private SSH key name defined in environment variables" }, "config_path": { "type": "string", "description": "Kubectl configuration file. Required when the platform is set to `KUBERNETES`" }, "image": { "type": "string", "description": "The name of the image" }, "service": { "type": "string", "description": "The name of the service" }, "platform": { "type": "string", "description": "Target platform for running commands", "enum": [ "MANAGED", "GKE", "KUBERNETES" ] }, "cluster": { "type": "string", "description": "The ID of the cluster or fully qualified identifier for the cluster. Required when the platform is set to `GKE`" }, "cluster_location": { "type": "string", "description": "The zone in which the cluster is located. Required when the platform is set to `GKE`" }, "context": { "type": "string", "description": "The name of the context in your kubectl config file to use for connecting. Required when the platform is set to `KUBERNETES`" }, "region": { "type": "string", "description": "The [region](https://cloud.google.com/compute/docs/regions-zones) in which the resource can be found. Required when platform is set to `MANAGED`" }, "arguments": { "type": "string", "description": "Additional arguments for the deployment command" } }, "deprecated": true, "x-name": "Google Cloud Run" }, "GcsActionRequest": { "required": [ "bucket_name", "integration", "local_path", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The current git revision" }, "local_path": { "type": "string", "description": "The path to the local files to deploy" }, "remote_path": { "type": "string", "description": "The path on the remote server where files will be deployed" }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "deployment_includes": { "type": "array", "description": "The list of files or directories to include in deployment", "items": { "type": "string", "description": "The list of files or directories to include in deployment" } }, "input_type": { "type": "string", "description": "The type of source input", "enum": [ "SCM_REPOSITORY", "BUILD_ARTIFACTS" ] }, "deletion_disabled": { "type": "boolean", "description": "If set to `true`, files on the remote server will not be deleted" }, "use_temporary_files": { "type": "boolean", "description": "If set to `true`, files will be uploaded to a temporary directory first" }, "content_encoding": { "type": "string", "description": "The content encoding for deployed files" }, "integration": { "$ref": "#/components/schemas/GoogleServiceAccountIntegrationRef" }, "application_name": { "type": "string", "description": "The name of the GCS application" }, "bucket_name": { "type": "string", "description": "The name of the GCS Bucket" }, "public_access": { "type": "boolean", "description": "Makes files accessible through public HTTP" }, "cache_control": { "type": "string", "description": "Specifies how long objects stay in the cache" } }, "deprecated": true, "x-name": "Google Cloud Storage" }, "GhostInspectorActionRequest": { "required": [ "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "integration": { "$ref": "#/components/schemas/GhostInspectorIntegrationRef" }, "api_key": { "type": "string", "description": "The API key for Ghost Inspector" }, "region": { "type": "string", "description": "Geo-location for test execution. The following options are available: `us-east-1`, `us-west-1`, `ca-central-1`, `eu-central-1`, `eu-west-1`, `eu-west-2`, `eu-west-3`, `eu-north-1`, `ap-northeast-1`, `ap-northeast-2`, `ap-southeast-1`, `ap-southeast-2`, `ap-south-1`, `sa-east-1`" }, "folder": { "type": "string", "description": "The ID of the folder to execute" }, "suite": { "type": "string", "description": "The ID of the suite to execute" }, "browser": { "type": "string", "description": "Alternate browser to use for this execution. The following options are available: `firefox` (default), `firefox-` specific version of Firefox, for example `firefox-57`, `chrome` (paid plans only), `phantomjs`" }, "channel": { "type": "string", "description": "Specify the Slack channel to notify for this suite run. Note that the value must be `myChannel` or `%23myChannel` and not `#myChannel`" }, "user": { "type": "string", "description": "The name to associate with the event" }, "password": { "type": "string", "description": "The password to associate with the event" }, "immediate": { "type": "boolean", "description": "Use to initiate the execution, then immediate return a response (without results)" }, "disable_notification": { "type": "boolean", "description": "Use to disable all notifications for this execution only" }, "start_url": { "type": "string", "description": "Alternate start URL to use for all tests in this execution only" }, "user_agent": { "type": "string", "description": "Alternate user agent to use for all tests in this execution only" }, "webhook": { "type": "string", "description": "The webhook URL to call after execution" }, "viewport": { "type": "string", "description": "Alternate screen size to use for all tests in this execution only. This should be a string formatted as `{width}x{height}`, for example `1024x768`" }, "data_file": { "type": "string", "description": "A CSV file containing a row of variable values for each suite run. A POST request must be used when sending this file. When included, an array of suite results will be returned instead of an array of test result" } }, "x-name": "Ghost Inspector" }, "GhostInspectorCliActionRequest": { "required": [ "execute_commands", "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/GhostInspectorIntegrationRef" }, "region": { "type": "string", "description": "Geo-location for test execution. The following options are available: `us-east-1`, `us-west-1`, `ca-central-1`, `eu-central-1`, `eu-west-1`, `eu-west-2`, `eu-west-3`, `eu-north-1`, `ap-northeast-1`, `ap-northeast-2`, `ap-southeast-1`, `ap-southeast-2`, `ap-south-1`, `sa-east-1`" } }, "x-name": "Ghost Inspector CLI" }, "GhostInspectorIntegrationRef": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" } }, "description": "Ghost Inspector integration (GHOST_INSPECTOR)" }, "GitCryptLockActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "force_arg": { "type": "boolean", "description": "Set to `true` if you want to lock even if there is uncommitted work in pipeline filesystem" }, "keys": { "type": "array", "description": "Key names you want to use to lock your repository", "items": { "$ref": "#/components/schemas/BinaryFileView" } } }, "x-name": "Git-Crypt lock" }, "GitCryptUnlockActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "force_arg": { "type": "boolean", "description": "Set to `true` if you want to lock even if there is uncommitted work in pipeline filesystem" }, "keys": { "type": "array", "description": "Key names you want to use to lock your repository", "items": { "$ref": "#/components/schemas/BinaryFileView" } } }, "x-name": "Git-Crypt unlock" }, "GitHubCliActionRequest": { "required": [ "execute_commands", "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/GitHubIntegrationRef" } }, "x-name": "GitHub CLI" }, "GitHubIntegrationRef": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" } }, "description": "GitHub integration (GIT_HUB|GIT_HUB_ENTERPRISE)" }, "GitHubReleaseActionRequest": { "required": [ "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "integration": { "$ref": "#/components/schemas/GitHubIntegrationRef" }, "tag_name": { "type": "string", "description": "The name of the tag" }, "target_commitish": { "type": "string", "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch" }, "release_name": { "type": "string", "description": "The name of the release" }, "body": { "type": "string", "description": "Text describing the contents of the tag" }, "draft": { "type": "boolean", "description": "Set to `true` to create a draft (unpublished) release or to `false` to create a published one. By default, it's set to `false`" }, "prerelease": { "type": "boolean", "description": "Set to `true` to identify the release as a prerelease. Set to `false` to identify the release as a full release. By default, it's set to `false`" }, "zip_assets": { "type": "boolean", "description": "Set to `true` to zip assets for release. By default, it's set to `true`" }, "repository": { "type": "string", "description": "The name of the repository" }, "organization": { "type": "string", "description": "The account owner of the repository. The name is not case-sensitive" }, "external_project_id": { "type": "string", "description": "The name of the repository. The name is not case-sensitive. Created from the field 'organization/repository name'" }, "assets": { "type": "array", "description": "The artifact of assets for this release. The path has to be provided in the `source_path` field and the label name in the `label` field", "items": { "$ref": "#/components/schemas/GitHubReleaseAssetReference" } } }, "x-name": "GitHub Release" }, "GitHubReleaseAssetReference": { "type": "object", "properties": { "source_path": { "type": "string", "description": "The path to the file to upload as a release asset" }, "label": { "type": "string", "description": "The display label for the release asset" } }, "description": "The artifact of assets for this release. The path has to be provided in the `source_path` field and the label name in the `label` field" }, "GitLabCliActionRequest": { "required": [ "execute_commands", "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/GitLabIntegrationRef" } }, "x-name": "GitLab CLI" }, "GitLabIntegrationRef": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" } }, "description": "GitLab integration (GIT_LAB|GIT_LAB_ENTERPRISE)" }, "GitMergeActionRequest": { "required": [ "branch", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "branch": { "type": "string", "description": "The source branch to merge into the current branch" }, "conflict_strategy": { "type": "string", "description": "The strategy for handling merge conflicts: `FAIL` (default), `OURS`, or `THEIRS`", "enum": [ "FAIL", "OURS", "THEIRS" ] }, "dry_run": { "type": "boolean", "description": "Set to `true` to only check if the merge is possible without actually performing it" }, "no_fast_forward": { "type": "boolean", "description": "Set to `true` to always create a merge commit even if a fast-forward merge is possible" }, "commiter_email": { "type": "string", "description": "The email address of the committer used in the merge commit" }, "commit_message": { "type": "string", "description": "The custom commit message for the merge commit" } }, "x-name": "Git Merge" }, "GoogleAppDeployActionRequest": { "required": [ "integration", "name", "server_key", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "integration": { "$ref": "#/components/schemas/GoogleServiceAccountIntegrationRef" }, "local_path": { "type": "string", "description": "The path to the local application files" }, "server_key": { "type": "string", "description": "The private SSH key" }, "env_key": { "type": "string", "description": "The private SSH key name defined in environment variables" }, "application_name": { "type": "string", "description": "The name of the Google App Engine application" }, "version_label": { "type": "string", "description": "The version label for the deployment" }, "bucket_name": { "type": "string", "description": "The name of the Google Cloud Storage bucket" }, "image_url": { "type": "string", "description": "The URL of the Docker image" }, "promote_all_traffic": { "type": "boolean", "description": "If set to `true`, all traffic will be promoted to the new version" }, "stop_previous_version": { "type": "boolean", "description": "If set to `true`, the previous version will be stopped" }, "verbosity": { "type": "string", "description": "The verbosity level for deployment logging" }, "config_path": { "type": "string", "description": "The path to the configuration file" } }, "x-name": "Google App Engine" }, "GoogleAppEngineActionRequest": { "required": [ "integration", "name", "server_key", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "integration": { "$ref": "#/components/schemas/GoogleServiceAccountIntegrationRef" }, "local_path": { "type": "string", "description": "The path to the local application files" }, "server_key": { "type": "string", "description": "The private SSH key" }, "env_key": { "type": "string", "description": "The private SSH key name defined in environment variables" }, "application_name": { "type": "string", "description": "The name of the Google App Engine application" }, "version_label": { "type": "string", "description": "The version label for the deployment" }, "bucket_name": { "type": "string", "description": "The name of the Google Cloud Storage bucket" }, "image_url": { "type": "string", "description": "The URL of the Docker image" }, "promote_all_traffic": { "type": "boolean", "description": "If set to `true`, all traffic will be promoted to the new version" }, "stop_previous_version": { "type": "boolean", "description": "If set to `true`, the previous version will be stopped" }, "verbosity": { "type": "string", "description": "The verbosity level for deployment logging" }, "config_path": { "type": "string", "description": "The path to the configuration file" } }, "deprecated": true, "x-name": "Google App Engine" }, "GoogleCdnActionRequest": { "required": [ "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "purge_all": { "type": "boolean", "description": "If set to `true`, all cached content will be purged" }, "purge_by_change_set_limit": { "type": "integer", "description": "The maximum number of files in the changeset to trigger purge", "format": "int32" }, "local_path": { "type": "string", "description": "The path to the local files to invalidate" }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from cache invalidation", "items": { "type": "string", "description": "The list of files or directories to exclude from cache invalidation" } }, "deployment_includes": { "type": "array", "description": "The list of files or directories to include in cache invalidation", "items": { "type": "string", "description": "The list of files or directories to include in cache invalidation" } }, "paths": { "type": "array", "description": "The list of paths to invalidate", "items": { "type": "string", "description": "The list of paths to invalidate" } }, "input_type": { "type": "string", "description": "The type of source input for invalidation (`SCM` or `BUILD_ARTIFACTS`)", "enum": [ "SCM_REPOSITORY", "BUILD_ARTIFACTS" ] }, "integration": { "$ref": "#/components/schemas/GoogleServiceAccountIntegrationRef" }, "distribution_id": { "type": "string", "description": "The ID of the Google web distribution" }, "url_map": { "type": "string", "description": "The name of the mapping rules" }, "remote_path": { "type": "string", "description": "The absolute or relative path on the remote server" } }, "deprecated": true, "x-name": "Google CDN" }, "GoogleCdnInvalidateActionRequest": { "required": [ "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "purge_all": { "type": "boolean", "description": "If set to `true`, all cached content will be purged" }, "purge_by_change_set_limit": { "type": "integer", "description": "The maximum number of files in the changeset to trigger purge", "format": "int32" }, "local_path": { "type": "string", "description": "The path to the local files to invalidate" }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from cache invalidation", "items": { "type": "string", "description": "The list of files or directories to exclude from cache invalidation" } }, "deployment_includes": { "type": "array", "description": "The list of files or directories to include in cache invalidation", "items": { "type": "string", "description": "The list of files or directories to include in cache invalidation" } }, "paths": { "type": "array", "description": "The list of paths to invalidate", "items": { "type": "string", "description": "The list of paths to invalidate" } }, "input_type": { "type": "string", "description": "The type of source input for invalidation (`SCM` or `BUILD_ARTIFACTS`)", "enum": [ "SCM_REPOSITORY", "BUILD_ARTIFACTS" ] }, "integration": { "$ref": "#/components/schemas/GoogleServiceAccountIntegrationRef" }, "distribution_id": { "type": "string", "description": "The ID of the Google web distribution" }, "url_map": { "type": "string", "description": "The name of the mapping rules" }, "remote_path": { "type": "string", "description": "The absolute or relative path on the remote server" } }, "x-name": "Google CDN" }, "GoogleChatActionRequest": { "required": [ "channel", "content", "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "integration": { "$ref": "#/components/schemas/GoogleServiceAccountIntegrationRef" }, "content": { "type": "string", "description": "The content of the notification" }, "channel": { "type": "string", "description": "The ID of the Google Chat channel" } }, "x-name": "Google Chat" }, "GoogleCloudCliActionRequest": { "required": [ "execute_commands", "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/GoogleServiceAccountIntegrationRef" }, "application_name": { "type": "string", "description": "The name of the Google application" }, "server_key": { "type": "string", "description": "The private SSH key" }, "env_key": { "type": "string", "description": "The private SSH key name defined in environment variables" }, "version": { "type": "string", "description": "The version of Google Cloud CLI to use. Defaults to `latest`" } }, "x-name": "GCloud CLI" }, "GoogleCloudRunDeployActionRequest": { "required": [ "integration", "name", "server_key", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "integration": { "$ref": "#/components/schemas/GoogleServiceAccountIntegrationRef" }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "application_name": { "type": "string", "description": "The name of the application" }, "server_key": { "type": "string", "description": "The private SSH key" }, "env_key": { "type": "string", "description": "The private SSH key name defined in environment variables" }, "config_path": { "type": "string", "description": "Kubectl configuration file. Required when the platform is set to `KUBERNETES`" }, "image": { "type": "string", "description": "The name of the image" }, "service": { "type": "string", "description": "The name of the service" }, "platform": { "type": "string", "description": "Target platform for running commands", "enum": [ "MANAGED", "GKE", "KUBERNETES" ] }, "cluster": { "type": "string", "description": "The ID of the cluster or fully qualified identifier for the cluster. Required when the platform is set to `GKE`" }, "cluster_location": { "type": "string", "description": "The zone in which the cluster is located. Required when the platform is set to `GKE`" }, "context": { "type": "string", "description": "The name of the context in your kubectl config file to use for connecting. Required when the platform is set to `KUBERNETES`" }, "region": { "type": "string", "description": "The [region](https://cloud.google.com/compute/docs/regions-zones) in which the resource can be found. Required when platform is set to `MANAGED`" }, "arguments": { "type": "string", "description": "Additional arguments for the deployment command" } }, "x-name": "Google Cloud Run" }, "GoogleCloudStorageActionRequest": { "required": [ "bucket_name", "integration", "local_path", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The current git revision" }, "local_path": { "type": "string", "description": "The path to the local files to deploy" }, "remote_path": { "type": "string", "description": "The path on the remote server where files will be deployed" }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "deployment_includes": { "type": "array", "description": "The list of files or directories to include in deployment", "items": { "type": "string", "description": "The list of files or directories to include in deployment" } }, "input_type": { "type": "string", "description": "The type of source input", "enum": [ "SCM_REPOSITORY", "BUILD_ARTIFACTS" ] }, "deletion_disabled": { "type": "boolean", "description": "If set to `true`, files on the remote server will not be deleted" }, "use_temporary_files": { "type": "boolean", "description": "If set to `true`, files will be uploaded to a temporary directory first" }, "content_encoding": { "type": "string", "description": "The content encoding for deployed files" }, "integration": { "$ref": "#/components/schemas/GoogleServiceAccountIntegrationRef" }, "application_name": { "type": "string", "description": "The name of the GCS application" }, "bucket_name": { "type": "string", "description": "The name of the GCS Bucket" }, "public_access": { "type": "boolean", "description": "Makes files accessible through public HTTP" }, "cache_control": { "type": "string", "description": "Specifies how long objects stay in the cache" } }, "x-name": "Google Cloud Storage" }, "GoogleFunctionDeployActionRequest": { "required": [ "integration", "name", "runtime", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "integration": { "$ref": "#/components/schemas/GoogleServiceAccountIntegrationRef" }, "local_path": { "type": "string", "description": "The path in the repository" }, "function_name": { "type": "string", "description": "The name of the Google function" }, "runtime": { "type": "string", "description": "The Cloud Functions execution environment. Options: `nodejs6`, `nodejs8`, `nodejs10`, `nodejs12`, `python37`, `go111`" }, "command_args": { "type": "string", "description": "Additional arguments sent upon deploying the function" }, "application_id": { "type": "string", "description": "The id of the Google Cloud project" }, "region": { "type": "string", "description": "Region in which function can be found or will be created" }, "server_key": { "type": "string", "description": "The private SSH key" } }, "x-name": "Google Functions Deploy" }, "GoogleFunctionInvokeActionRequest": { "required": [ "function_name", "integration", "name", "region", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "function_name": { "type": "string", "description": "The name of the function to invoke" }, "region": { "type": "string", "description": "The region where the function is located" }, "payload": { "type": "string", "description": "The payload to send to the function" }, "integration": { "$ref": "#/components/schemas/GoogleServiceAccountIntegrationRef" }, "application_id": { "type": "string", "description": "The id of the Google Cloud project" } }, "x-name": "Google Functions" }, "GoogleFunctionsActionRequest": { "required": [ "function_name", "integration", "name", "region", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "function_name": { "type": "string", "description": "The name of the function to invoke" }, "region": { "type": "string", "description": "The region where the function is located" }, "payload": { "type": "string", "description": "The payload to send to the function" }, "integration": { "$ref": "#/components/schemas/GoogleServiceAccountIntegrationRef" }, "application_id": { "type": "string", "description": "The id of the Google Cloud project" } }, "deprecated": true, "x-name": "Google Functions" }, "GoogleFunctionsDeployActionRequest": { "required": [ "integration", "name", "runtime", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "integration": { "$ref": "#/components/schemas/GoogleServiceAccountIntegrationRef" }, "local_path": { "type": "string", "description": "The path in the repository" }, "function_name": { "type": "string", "description": "The name of the Google function" }, "runtime": { "type": "string", "description": "The Cloud Functions execution environment. Options: `nodejs6`, `nodejs8`, `nodejs10`, `nodejs12`, `python37`, `go111`" }, "command_args": { "type": "string", "description": "Additional arguments sent upon deploying the function" }, "application_id": { "type": "string", "description": "The id of the Google Cloud project" }, "region": { "type": "string", "description": "Region in which function can be found or will be created" }, "server_key": { "type": "string", "description": "The private SSH key" } }, "deprecated": true, "x-name": "Google Functions Deploy" }, "GooglePlayStoreIntegrationRef": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" } }, "description": "Google Play Store integration (GOOGLE_PLAY_STORE)" }, "GoogleServiceAccountIntegrationRef": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" } }, "description": "Google Service Account integration (GOOGLE_SERVICE_ACCOUNT)" }, "HeaderView": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the HTTP header" }, "value": { "type": "string", "description": "The value of the HTTP header" } }, "description": "The HTTP headers to include in the request" }, "HelmActionRequest": { "required": [ "name", "namespace", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "config_path": { "type": "string", "description": "The path to the Kubernetes configuration file" }, "kubectl_version": { "type": "string", "description": "The version of kubectl to use" }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "targets": { "type": "array", "description": "The list of Kubernetes cluster targets", "items": { "$ref": "#/components/schemas/TargetView" } }, "namespace": { "type": "string", "description": "The Kubernetes namespace" }, "content": { "type": "string", "description": "The content of the Kubernetes configuration" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "execute_commands": { "type": "array", "description": "Commands that will be executed", "items": { "type": "string", "description": "Commands that will be executed" } }, "helm_version": { "type": "string", "description": "The Helm version" }, "helm_repository_key": { "type": "string", "description": "Service Account Key from Google Cloud Storage. Set it if Helm repository is on GCS" }, "helm_repository_region": { "type": "string", "description": "Helm repository region. Set it if Helm repository is on AWS S3" }, "helm_repository_integration": { "$ref": "#/components/schemas/IntegrationRequestView" } }, "x-name": "Kubernetes Run Helm CMDs" }, "HerokuActionRequest": { "required": [ "application_name", "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "push_tags": { "type": "boolean", "description": "If set to `true`, tags will be pushed to the repository" }, "push_only_tags": { "type": "boolean", "description": "If set to `true`, only tags will be pushed without commits" }, "target_branch": { "type": "string", "description": "The target branch to push to" }, "without_force": { "type": "boolean", "description": "If set to `true`, force push will not be used" }, "isolated": { "type": "boolean", "description": "If set to `true`, the action will run in an isolated environment" }, "use_custom_gitignore": { "type": "boolean", "description": "If set to `true`, custom .gitignore rules will be used" }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "comment": { "type": "string", "description": "The commit message for the push" }, "tag": { "type": "string", "description": "The tag name to create and push" }, "custom_options": { "type": "string", "description": "Custom git push options" }, "targets": { "type": "array", "description": "The list of target repositories to push to", "items": { "$ref": "#/components/schemas/TargetView" } }, "integration": { "$ref": "#/components/schemas/HerokuIntegrationRef" }, "application_name": { "type": "string", "description": "The name of the application" } }, "x-name": "Heroku" }, "HerokuCliActionRequest": { "required": [ "execute_commands", "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/HerokuIntegrationRef" }, "region": { "type": "string", "description": "The region where the application is deployed" }, "application_name": { "type": "string", "description": "The name of the application" } }, "x-name": "Heroku CLI" }, "HerokuIntegrationRef": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" } }, "description": "Heroku integration (HEROKU)" }, "HoneybadgerActionRequest": { "required": [ "environment", "integration", "name", "project", "token", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "integration": { "$ref": "#/components/schemas/HoneybadgerIntegrationRef" }, "project": { "type": "string", "description": "The project identifier" }, "token": { "type": "string", "description": "The Honeybadger token." }, "environment": { "type": "string", "description": "The Honeybadger environment." } }, "x-name": "Honeybadger" }, "HoneybadgerIntegrationRef": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" } }, "description": "Honeybadger integration (HONEYBADGER)" }, "HttpActionRequest": { "required": [ "method", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "content": { "type": "string", "description": "The content of the request." }, "method": { "type": "string", "description": "The desired HTTP method", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] }, "headers": { "type": "array", "description": "The headers that will be sent with the request.", "items": { "$ref": "#/components/schemas/HeaderView" } }, "login": { "type": "string", "description": "The username required to connect to the server." }, "notification_url": { "type": "string", "description": "The target URL." }, "port": { "type": "string", "description": "The port for the connection." }, "password": { "type": "string", "description": "The password required to connect to the server." }, "paths": { "type": "array", "description": "The list of paths for the request", "items": { "type": "string", "description": "The list of paths for the request" } }, "multipart_upload": { "type": "boolean", "description": "Enables multipart upload for the request" } }, "x-name": "HTTP Request" }, "HttpSettingsView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "verify_certificate": { "type": "boolean", "description": "Whether to verify SSL/TLS certificates" }, "compression": { "type": "boolean", "description": "Enable HTTP compression" }, "http2": { "type": "boolean", "description": "Enable HTTP/2 protocol support" }, "log_requests": { "type": "boolean", "description": "Log incoming HTTP requests" }, "request_headers": { "type": "object", "additionalProperties": { "type": "string", "description": "Custom HTTP headers to add to requests" }, "description": "Custom HTTP headers to add to requests" }, "whitelist_user_agents": { "type": "array", "description": "List of allowed User-Agent strings", "items": { "type": "string", "description": "List of allowed User-Agent strings" } }, "rewrite_host_header": { "type": "string", "description": "Rewrite the Host header to this value" }, "response_headers": { "type": "object", "additionalProperties": { "type": "string", "description": "Custom HTTP headers to add to responses" }, "description": "Custom HTTP headers to add to responses" }, "login": { "type": "string", "description": "Basic authentication username" }, "password": { "type": "string", "description": "Basic authentication password", "writeOnly": true }, "tls_ca": { "type": "string", "description": "Custom TLS Certificate Authority", "writeOnly": true }, "circuit_breaker": { "type": "integer", "description": "Circuit breaker threshold (number of failed requests)", "format": "int32" }, "serve_path": { "type": "string", "description": "Base path for serving requests" }, "auth_type": { "type": "string", "description": "Type of authentication used", "enum": [ "NONE", "BASIC", "BUDDY" ] } }, "description": "The HTTP-specific settings of the tunnel" }, "ImageCompressionActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "local_path": { "type": "string", "description": "The path in the repository." }, "destination": { "type": "string", "description": "Output directory for compressed images." }, "level": { "type": "string", "description": "The level of image compression. Can be set to `1` (low), `2` (medium) or `3` (high)." }, "types": { "type": "string", "description": "Supported image formats. Available types: `jpg`, `png`, `gif`, `svg`." } }, "x-name": "Compress images" }, "InputView": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the input parameter" }, "value": { "type": "string", "description": "The value of the input parameter (encrypted if masked is true)" }, "masked": { "type": "boolean", "description": "If set to `true`, the input value will be encrypted" } }, "description": "The list of input parameters for the custom action" }, "IntegrationIdView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "identifier": { "type": "string", "description": "A human-readable ID of the integration" }, "hash_id": { "type": "string", "description": "The unique hash ID of the integration" }, "name": { "type": "string", "description": "The name of the integration" }, "type": { "type": "string", "description": "The type of integration", "enum": [ "GIT_HUB", "BITBUCKET", "GOOGLE", "DIGITAL_OCEAN", "SLACK", "MODULUS", "HEROKU", "AMAZON", "GIT_LAB", "SHOPIFY", "GIT_HUB_ENTERPRISE", "GIT_LAB_ENTERPRISE", "PUSHOVER", "PUSHBULLET", "RACKSPACE", "CUSTOM", "CLOUDFLARE", "NEW_RELIC", "SENTRY", "ROLLBAR", "DATADOG", "DO_SPACES", "HONEYBADGER", "VULTR", "SENTRY_ENTERPRISE", "LOGGLY", "HIP_CHAT", "FIREBASE", "TELEGRAM", "AZURE", "UPCLOUD", "GHOST_INSPECTOR", "NETLIFY", "AZURE_CLOUD", "MICROSOFT_TEAMS", "GOOGLE_SERVICE_ACCOUNT", "GOOGLE_PLAY_STORE", "DOCKER_HUB", "APP_STORE", "GIT_HUB_APP", "GIT_HUB_APP_ENTERPRISE", "GIT_HUB_API", "ATOP", "SNYK", "STACK_HAWK", "BLACKFIRE", "BACKBLAZE", "ONE_LOGIN", "OKTA", "CONTENTFUL", "JIRA", "NPM_REGISTRY", "ANTHROPIC" ] }, "auth_type": { "type": "string", "description": "The authentication method used by the integration", "enum": [ "OAUTH", "TOKEN", "API_KEY", "APP", "APP_SPRYKER", "TOKEN_APP_EXTENSION", "DEFAULT", "OIDC", "TRUSTED", "APP_RW" ] }, "host_url": { "type": "string", "description": "The host URL for custom integrations" }, "webhook_address": { "type": "string", "description": "The webhook URL for receiving notifications" }, "atop_url": { "type": "string", "description": "The ATOP service URL" }, "app_id": { "type": "string", "description": "The application ID for Azure Cloud integrations" }, "google_project": { "type": "string", "description": "The Google Cloud project ID" }, "audience": { "type": "string", "description": "The JWT audience for token validation" } }, "description": "Integration reference" }, "IntegrationPermissionsView": { "type": "object", "properties": { "others": { "type": "string", "description": "Access level for other workspace members", "enum": [ "DENIED", "READ_ONLY", "USE_ONLY", "BLIND", "RUN_ONLY", "READ_WRITE", "MANAGE", "DEFAULT", "ALLOWED", "STAGE", "COMMIT" ] }, "users": { "type": "array", "description": "List of specific users with their access levels", "items": { "$ref": "#/components/schemas/UserPermissionView" } }, "groups": { "type": "array", "description": "List of user groups with their access levels", "items": { "$ref": "#/components/schemas/GroupPermissionView" } }, "admins": { "type": "string", "description": "Access level for workspace administrators", "enum": [ "DENIED", "READ_ONLY", "USE_ONLY", "BLIND", "RUN_ONLY", "READ_WRITE", "MANAGE", "DEFAULT", "ALLOWED", "STAGE", "COMMIT" ] } }, "description": "Permission settings defining who can use this integration" }, "IntegrationRequestView": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" } }, "description": "Helm repository integration (GOOGLE_SERVICE_ACCOUNT|AMAZON)" }, "IntegrationVariablesActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "integration_from": { "type": "string", "description": "Defines the source from which integration will be used to generate variables", "enum": [ "ACTION", "PROJECT" ] }, "integration": { "$ref": "#/components/schemas/IntegrationVariablesIntegrationRef" } }, "x-name": "Generate variables" }, "IntegrationVariablesIntegrationRef": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" } }, "description": "Integration is required when `integration_from` is set to `ACTION` (allowed integration types: DOCKER_HUB|GOOGLE_SERVICE_ACCOUNT|AMAZON|DIGITAL_OCEAN|GIT_HUB|GIT_HUB_ENTERPRISE|GIT_LAB|GIT_LAB_ENTERPRISE|GOOGLE_PLAY_STORE|SNYK)" }, "IntegrationView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "identifier": { "type": "string", "description": "A human-readable ID of the integration" }, "hash_id": { "type": "string", "description": "The unique hash ID of the integration" }, "name": { "type": "string", "description": "The name of the integration" }, "type": { "type": "string", "description": "The type of integration", "enum": [ "GIT_HUB", "BITBUCKET", "GOOGLE", "DIGITAL_OCEAN", "SLACK", "MODULUS", "HEROKU", "AMAZON", "GIT_LAB", "SHOPIFY", "GIT_HUB_ENTERPRISE", "GIT_LAB_ENTERPRISE", "PUSHOVER", "PUSHBULLET", "RACKSPACE", "CUSTOM", "CLOUDFLARE", "NEW_RELIC", "SENTRY", "ROLLBAR", "DATADOG", "DO_SPACES", "HONEYBADGER", "VULTR", "SENTRY_ENTERPRISE", "LOGGLY", "HIP_CHAT", "FIREBASE", "TELEGRAM", "AZURE", "UPCLOUD", "GHOST_INSPECTOR", "NETLIFY", "AZURE_CLOUD", "MICROSOFT_TEAMS", "GOOGLE_SERVICE_ACCOUNT", "GOOGLE_PLAY_STORE", "DOCKER_HUB", "APP_STORE", "GIT_HUB_APP", "GIT_HUB_APP_ENTERPRISE", "GIT_HUB_API", "ATOP", "SNYK", "STACK_HAWK", "BLACKFIRE", "BACKBLAZE", "ONE_LOGIN", "OKTA", "CONTENTFUL", "JIRA", "NPM_REGISTRY", "ANTHROPIC" ] }, "auth_type": { "type": "string", "description": "The authentication method used by the integration", "enum": [ "OAUTH", "TOKEN", "API_KEY", "APP", "APP_SPRYKER", "TOKEN_APP_EXTENSION", "DEFAULT", "OIDC", "TRUSTED", "APP_RW" ] }, "scope": { "type": "string", "description": "The scope of the integration", "enum": [ "WORKSPACE", "PROJECT", "ENVIRONMENT" ] }, "project_name": { "type": "string", "description": "The human-readable ID of the project (required when scope is `PROJECT`)" }, "app_id": { "type": "string", "description": "The application ID for Azure Cloud integrations" }, "google_project": { "type": "string", "description": "The Google Cloud project ID" }, "host_url": { "type": "string", "description": "The host URL for custom integrations" }, "webhook_address": { "type": "string", "description": "The webhook URL for receiving notifications" }, "audience": { "type": "string", "description": "The JWT audience for token validation" }, "atop_url": { "type": "string", "description": "The ATOP service URL" }, "permissions": { "$ref": "#/components/schemas/IntegrationPermissionsView" }, "all_pipelines_allowed": { "type": "boolean", "description": "Set to `true` to allow all pipelines to use this integration" }, "allowed_pipelines": { "type": "array", "description": "List of specific pipelines allowed to use this integration", "items": { "$ref": "#/components/schemas/ShortPipelineView" } }, "disabled": { "type": "boolean", "description": "Set to `true` to disable the integration. Disabled integrations cannot be used in actions" } }, "description": "The integration to use for authentication" }, "JiraBuildActionRequest": { "required": [ "description", "integration", "issueKey", "name", "state", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "integration": { "$ref": "#/components/schemas/JiraIntegrationRef" }, "issueKey": { "type": "string", "description": "Jira issue key (e.g., PROJ-123)" }, "display_name": { "type": "string", "description": "Display name for the build" }, "description": { "type": "string", "description": "Description of the build" }, "state": { "type": "string", "description": "Build state (pending, in_progress, successful, failed, cancelled, unknown)" } }, "x-name": "Jira Build" }, "JiraDeploymentActionRequest": { "required": [ "description", "integration", "issueKey", "name", "state", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "integration": { "$ref": "#/components/schemas/JiraIntegrationRef" }, "issueKey": { "type": "string", "description": "Jira issue key (e.g., PROJ-123)" }, "display_name": { "type": "string", "description": "Display name for the deployment" }, "description": { "type": "string", "description": "Description of the deployment" }, "state": { "type": "string", "description": "Deployment state (pending, in_progress, successful, failed, cancelled, rolled_back, unknown)" }, "environment_id": { "type": "string", "description": "Environment ID" }, "environment_name": { "type": "string", "description": "Environment name" }, "environment_type": { "type": "string", "description": "Environment type (unmapped, development, testing, staging, production)", "enum": [ "unmapped", "development", "testing", "staging", "production" ] } }, "x-name": "Jira Deployment" }, "JiraIntegrationRef": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" } }, "description": "The Jira integration" }, "JmeterActionRequest": { "required": [ "execute_commands", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" } }, "x-name": "JMeter CLI" }, "KubernetesApplyActionRequest": { "required": [ "name", "namespace", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "config_path": { "type": "string", "description": "The path to the Kubernetes configuration file" }, "kubectl_version": { "type": "string", "description": "The version of kubectl to use" }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "targets": { "type": "array", "description": "The list of Kubernetes cluster targets", "items": { "$ref": "#/components/schemas/TargetView" } }, "namespace": { "type": "string", "description": "The Kubernetes namespace" }, "content": { "type": "string", "description": "The content of the Kubernetes configuration" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "record_arg": { "type": "string", "description": "Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists", "enum": [ "TRUE", "FALSE", "NOT_SET" ] }, "save_config_arg": { "type": "boolean", "description": "If `true`, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future." }, "overwrite_arg": { "type": "boolean", "description": "Automatically resolve conflicts between the modified and live configuration by using values from the modified configuration." }, "cascade_arg": { "type": "boolean", "description": "Only relevant during a prune or a force apply. If `true`, cascade the deletion of the resources managed by pruned or deleted resources (e.g. Pods created by a ReplicationController)." }, "cascade": { "type": "string", "description": "Defines cascade deletion behavior for resources", "enum": [ "BACKGROUND", "ORPHAN", "FOREGROUND" ] }, "all_arg": { "type": "boolean", "description": "Defines whether to select all the specified resources." }, "grace_period_arg": { "type": "integer", "description": "Only relevant during a prune or a force apply. Period of time in seconds given to pruned or deleted resources to terminate gracefully. Ignored if negative.", "format": "int32" }, "prune_arg": { "type": "boolean", "description": "Automatically delete resource objects that do not appear in the configs and are created by either apply or create –save-config. Should be used with either -l or –all." }, "prune_whitelist_arg": { "type": "string", "description": "Overwrite the default whitelist with `` for –prune." }, "force_arg": { "type": "boolean", "description": "Delete and re-create the specified resource, when PATCH encounters conflict and has retried for 5 times." }, "validate": { "type": "boolean", "description": "Validates the configuration before applying" } }, "x-name": "Kubernetes Apply Deployment" }, "KubernetesCliActionRequest": { "required": [ "name", "namespace", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "config_path": { "type": "string", "description": "The path to the Kubernetes configuration file" }, "kubectl_version": { "type": "string", "description": "The version of kubectl to use" }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "targets": { "type": "array", "description": "The list of Kubernetes cluster targets", "items": { "$ref": "#/components/schemas/TargetView" } }, "namespace": { "type": "string", "description": "The Kubernetes namespace" }, "content": { "type": "string", "description": "The content of the Kubernetes configuration" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "execute_commands": { "type": "array", "description": "The commands that will be executed.", "items": { "type": "string", "description": "The commands that will be executed." } }, "helm_version": { "type": "string", "description": "The Helm version" } }, "x-name": "Kubernetes kubectl" }, "KubernetesRunJobActionRequest": { "required": [ "name", "namespace", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "config_path": { "type": "string", "description": "The path to the Kubernetes configuration file" }, "kubectl_version": { "type": "string", "description": "The version of kubectl to use" }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "targets": { "type": "array", "description": "The list of Kubernetes cluster targets", "items": { "$ref": "#/components/schemas/TargetView" } }, "namespace": { "type": "string", "description": "The Kubernetes namespace" }, "content": { "type": "string", "description": "The content of the Kubernetes configuration" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "leave_after": { "type": "boolean", "description": "If set to `true`, resources will be left after the action completes" }, "not_wait": { "type": "boolean", "description": "If set to `true`, the action will not wait for resources to be ready" }, "record_arg": { "type": "string", "description": "The record argument for the Kubernetes command", "enum": [ "TRUE", "FALSE", "NOT_SET" ] }, "save_config_arg": { "type": "boolean", "description": "If set to `true`, the configuration will be saved in the resource annotation" } }, "x-name": "Kubernetes Run Job" }, "KubernetesRunPodActionRequest": { "required": [ "name", "namespace", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "config_path": { "type": "string", "description": "The path to the Kubernetes configuration file" }, "kubectl_version": { "type": "string", "description": "The version of kubectl to use" }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "targets": { "type": "array", "description": "The list of Kubernetes cluster targets", "items": { "$ref": "#/components/schemas/TargetView" } }, "namespace": { "type": "string", "description": "The Kubernetes namespace" }, "content": { "type": "string", "description": "The content of the Kubernetes configuration" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "leave_after": { "type": "boolean", "description": "If set to `true`, resources will be left after the action completes" }, "not_wait": { "type": "boolean", "description": "If set to `true`, the action will not wait for resources to be ready" }, "record_arg": { "type": "string", "description": "The record argument for the Kubernetes command", "enum": [ "TRUE", "FALSE", "NOT_SET" ] }, "save_config_arg": { "type": "boolean", "description": "If set to `true`, the configuration will be saved in the resource annotation" } }, "x-name": "Kubernetes Run Pod" }, "KubernetesSetImageActionRequest": { "required": [ "container", "deployment", "image_name", "image_tag", "name", "namespace", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "config_path": { "type": "string", "description": "The path to the Kubernetes configuration file" }, "kubectl_version": { "type": "string", "description": "The version of kubectl to use" }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "targets": { "type": "array", "description": "The list of Kubernetes cluster targets", "items": { "$ref": "#/components/schemas/TargetView" } }, "namespace": { "type": "string", "description": "The Kubernetes namespace" }, "content": { "type": "string", "description": "The content of the Kubernetes configuration" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "deployment": { "type": "string", "description": "The name of the deployment from the namespace." }, "container": { "type": "string", "description": "The name of the container." }, "image_name": { "type": "string", "description": "The name of the image to set." }, "image_tag": { "type": "string", "description": "The tag of the chosen image." }, "record_arg": { "type": "string", "description": "Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists", "enum": [ "TRUE", "FALSE", "NOT_SET" ] } }, "x-name": "Kubernetes Set Image" }, "LighthouseActionRequest": { "required": [ "accessibility", "best_practices", "device", "name", "performance", "seo", "type", "website" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "website": { "type": "string", "description": "The address of the site on which the audit should run" }, "device": { "type": "string", "description": "The device on which the audit will be run" }, "max_results": { "type": "integer", "description": "The maximum number of results to store", "format": "int32" }, "performance": { "type": "integer", "description": "Values from 0 to 100 are accepted. The action returns an error if the score is below the values that are set", "format": "int32" }, "accessibility": { "type": "integer", "description": "Values from 0 to 100 are accepted. The action returns an error if the score is below the values that are set", "format": "int32" }, "best_practices": { "type": "integer", "description": "Values from 0 to 100 are accepted. The action returns an error if the score is below the values that are set", "format": "int32" }, "seo": { "type": "integer", "description": "Values from 0 to 100 are accepted. The action returns an error if the score is below the values that are set", "format": "int32" }, "first_contentful_paint": { "type": "number", "description": "The maximum First Contentful Paint metric threshold", "format": "float" }, "first_meaningful_paint": { "type": "number", "description": "The maximum First Meaningful Paint metric threshold", "format": "float" }, "speed_index": { "type": "number", "description": "The maximum Speed Index metric threshold", "format": "float" }, "estimated_input_latency": { "type": "number", "description": "The maximum Estimated Input Latency metric threshold", "format": "float" }, "total_blocking_time": { "type": "number", "description": "The maximum Total Blocking Time metric threshold", "format": "float" }, "max_potential_fid": { "type": "number", "description": "The maximum Max Potential First Input Delay metric threshold", "format": "float" }, "time_to_first_byte": { "type": "number", "description": "The maximum Time to First Byte metric threshold", "format": "float" }, "first_cpu_idle": { "type": "number", "description": "The maximum First CPU Idle metric threshold", "format": "float" }, "bootup_time": { "type": "number", "description": "The maximum JavaScript bootup time metric threshold", "format": "float" }, "network_server_latency": { "type": "number", "description": "The maximum network server latency metric threshold", "format": "float" }, "interactive": { "type": "number", "description": "The maximum Time to Interactive metric threshold", "format": "float" } }, "x-name": "Lighthouse" }, "LinkCheckerActionRequest": { "required": [ "name", "scan_url", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "cache_base_image": { "type": "boolean", "description": "Defines whether to cache the base Docker image" }, "scan_url": { "type": "string", "description": "The address of the site to be checked by the validator." }, "ba_username": { "type": "string", "description": "The basic auth username value." }, "ba_password": { "type": "string", "description": "The basic auth password value." }, "max_results": { "type": "integer", "description": "The maximum number of results to return", "format": "int32" }, "cookies": { "type": "array", "description": "Set the cookie name/value. Can be given more than once.", "items": { "$ref": "#/components/schemas/CookieView" } }, "threads": { "type": "integer", "description": "Generate no more than the given number of threads. The default number of threads is 10. To disable threading specify a non-positive number.", "format": "int32" }, "depth": { "type": "integer", "description": "Check recursively all links up to the given depth. A negative depth will enable infinite recursion. The default depth is infinite.", "format": "int32" }, "connection_timeout": { "type": "integer", "description": "Set the timeout for connection attempts in seconds. The default timeout is 60 seconds.", "format": "int32" }, "user_agent": { "type": "string", "description": "Specify the User-Agent string to send to the HTTP server, for example `Mozilla/4.0`. The default is `LinkChecker/X.Y` where X.Y is the current version of LinkChecker." }, "requests_per_host": { "type": "integer", "description": "Limit the maximum number of HTTP requests per second to one host. The average number of requests per second is approximately one third of the maximum. Values less than 1 and at least 0.001 can be used. To use values greater than 10, the HTTP server must return a \"LinkChecker\" response header. The default is 10.", "format": "int32" }, "respect_robot_exclusions": { "type": "boolean", "description": "When using HTTP, fetch robots.txt, and confirm whether each URL should be accessed before checking. The default is to use robots.txt files." }, "check_ssl_certificate": { "type": "boolean", "description": "If set to zero, it disables the SSL certificate checking. If set to one, it enables the SSL certificate checking with the provided CA certificate file. If a filename is specified, it will be used as the certificate file." }, "internal_links": { "type": "string", "description": "The regular expression to add more URLs recognized as internal links. The default is that URLs given on the command line are internal." }, "check_external_links": { "type": "boolean", "description": "Check external links. The default is to check internal links only." }, "ignore_urls": { "type": "array", "description": "Only check the syntax of URLs matching the given regular expressions.", "items": { "type": "string", "description": "Only check the syntax of URLs matching the given regular expressions." } }, "no_follow_urls": { "type": "array", "description": "Check but do not recurse into URLs matching the given regular expressions.", "items": { "type": "string", "description": "Check but do not recurse into URLs matching the given regular expressions." } }, "warning_regex": { "type": "string", "description": "Only check syntax of URLs matching the given regular expressions." }, "html_form_auth_username_input_name": { "type": "string", "description": "The name attribute of the username input element." }, "html_form_auth_password_input_name": { "type": "string", "description": "The name attribute of the password input element." }, "html_form_auth_username": { "type": "string", "description": "The HTML form username value." }, "html_form_auth_password": { "type": "string", "description": "The HTML form password value." }, "html_form_auth_url": { "type": "string", "description": "The URL of a login page to be visited before link checking. The page is expected to contain an HTML form to collect credentials and submit them to the address in its action attribute using an HTTP POST request." } }, "x-name": "Link Checker" }, "LinkValidatorActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "website": { "type": "string", "description": "The URL of the website to validate" }, "depth": { "type": "integer", "description": "Check recursively all links up to the given depth", "format": "int32" }, "ignored_prefixes": { "type": "array", "description": "URL prefixes to ignore during validation", "items": { "type": "string", "description": "URL prefixes to ignore during validation" } } }, "description": "This action type is deprecated. Please use LINK_CHECKER action instead.", "deprecated": true, "x-name": "Link Validator" }, "LinuxNativeBuildActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "working_directory": { "type": "string", "description": "The directory in which the pipeline filesystem will be mounted" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "commands": { "type": "array", "description": "The commands to execute in the native build environment", "items": { "type": "string", "description": "The commands to execute in the native build environment" } }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "vm_from_prev_action": { "type": "boolean", "description": "If set to `true`, the VM from the previous action will be used" }, "vm_action_id": { "type": "integer", "description": "The ID of the action from which the VM will be used", "format": "int32" }, "vm_action_name": { "type": "string", "description": "The name of the action from which the VM will be used" }, "instance_type": { "type": "string", "description": "The type of instance to use for the native build", "enum": [ "GENERAL_MEDIUM", "GENERAL_LARGE", "GENERAL_XLARGE", "GENERAL_2XLARGE", "COMPUTE_MEDIUM", "COMPUTE_LARGE", "COMPUTE_XLARGE", "COMPUTE_2XLARGE", "ARM_GENERAL_MEDIUM", "ARM_GENERAL_LARGE", "ARM_GENERAL_XLARGE", "ARM_GENERAL_2XLARGE", "ARM_COMPUTE_MEDIUM", "ARM_COMPUTE_LARGE", "ARM_COMPUTE_XLARGE", "ARM_COMPUTE_2XLARGE" ] }, "sync_paths": { "type": "array", "description": "Define file paths that should be copied before (`PIPELINE_TO_VM`) and after the execution (`VM_TO_PIPELINE`).", "items": { "$ref": "#/components/schemas/SyncPathView" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "distribution": { "type": "string", "description": "Defines the image used to create the VM", "enum": [ "UBUNTU_20_04", "AMI", "WINDOWS_SERVER_2019", "PREVIOUS_ACTION" ] }, "ami": { "$ref": "#/components/schemas/AmiView" } }, "x-name": "Linux" }, "LlmBuildPromptView": { "type": "object", "properties": { "type": { "type": "string", "description": "The prompt type: `INLINE` or `FILE`." }, "value": { "type": "string", "description": "The prompt content (inline text) or file path." } }, "description": "List of prompts to send to Claude Code. Each prompt has a `type` (`INLINE` or `FILE`) and a `value`." }, "LogglyActionRequest": { "required": [ "integration", "name", "tags", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "integration": { "$ref": "#/components/schemas/LogglyIntegrationRef" }, "content": { "type": "string", "description": "The content of the notification." }, "tags": { "uniqueItems": true, "type": "array", "description": "The list of Loggly tags used for segmentation and filtering.", "items": { "type": "string", "description": "The list of Loggly tags used for segmentation and filtering." } } }, "x-name": "Loggly" }, "LogglyIntegrationRef": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" } }, "description": "Loggly integration (LOGGLY)" }, "MacCordovaNativeBuildActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "working_directory": { "type": "string", "description": "The directory in which the pipeline filesystem will be mounted" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "commands": { "type": "array", "description": "The commands to execute in the native build environment", "items": { "type": "string", "description": "The commands to execute in the native build environment" } }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "vm_from_prev_action": { "type": "boolean", "description": "If set to `true`, the VM from the previous action will be used" }, "vm_action_id": { "type": "integer", "description": "The ID of the action from which the VM will be used", "format": "int32" }, "vm_action_name": { "type": "string", "description": "The name of the action from which the VM will be used" }, "instance_type": { "type": "string", "description": "The type of instance to use for the native build", "enum": [ "GENERAL_MEDIUM", "GENERAL_LARGE", "GENERAL_XLARGE", "GENERAL_2XLARGE", "COMPUTE_MEDIUM", "COMPUTE_LARGE", "COMPUTE_XLARGE", "COMPUTE_2XLARGE", "ARM_GENERAL_MEDIUM", "ARM_GENERAL_LARGE", "ARM_GENERAL_XLARGE", "ARM_GENERAL_2XLARGE", "ARM_COMPUTE_MEDIUM", "ARM_COMPUTE_LARGE", "ARM_COMPUTE_XLARGE", "ARM_COMPUTE_2XLARGE" ] }, "xcode_version": { "type": "string", "description": "The version of Xcode to use" }, "pre_start_simulators": { "type": "array", "description": "The list of simulators to start before the build", "items": { "type": "string", "description": "The list of simulators to start before the build" } }, "node_version": { "type": "string", "description": "The version of Node.js to use" }, "flutter_version": { "type": "string", "description": "The version of Flutter to use" }, "archive_location": { "type": "string", "description": "The path to the archive location" }, "certificates": { "type": "array", "description": "The list of certificates to use for signing", "items": { "type": "string", "description": "The list of certificates to use for signing" } }, "provision_profiles": { "type": "array", "description": "The list of provisioning profiles to use", "items": { "type": "string", "description": "The list of provisioning profiles to use" } }, "sign_mode": { "type": "string", "description": "The signing mode", "enum": [ "MANUAL", "AUTOMATIC" ] }, "distribution_method": { "type": "string", "description": "The distribution method", "enum": [ "APP_STORE", "AD_HOC", "DEVELOPMENT", "ENTERPRISE" ] }, "export_location": { "type": "string", "description": "The path to export the signed app" }, "property_list_source": { "type": "string", "description": "The source of the property list", "enum": [ "GENERATED", "PIPELINE_VOLUME", "VARIABLE", "ACTION" ] }, "property_list": { "type": "string", "description": "The content of the property list" }, "validate_before_upload": { "type": "boolean", "description": "If set to `true`, the app will be validated before upload" }, "submit_for_review": { "type": "boolean", "description": "If set to `true`, the app will be submitted for review" }, "skip_metadata": { "type": "boolean", "description": "If set to `true`, metadata will not be uploaded" }, "skip_app_version_update": { "type": "boolean", "description": "If set to `true`, the app version will not be updated" }, "skip_screenshots": { "type": "boolean", "description": "If set to `true`, screenshots will not be uploaded" }, "sync_paths": { "type": "array", "description": "Define file paths that should be copied before (`PIPELINE_TO_VM`) and after the execution (`VM_TO_PIPELINE`).", "items": { "$ref": "#/components/schemas/SyncPathView" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] } }, "x-name": "Build a Cordova App" }, "MacDeployNativeBuildActionRequest": { "required": [ "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "working_directory": { "type": "string", "description": "The directory in which the pipeline filesystem will be mounted" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "commands": { "type": "array", "description": "The commands to execute in the native build environment", "items": { "type": "string", "description": "The commands to execute in the native build environment" } }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "vm_from_prev_action": { "type": "boolean", "description": "If set to `true`, the VM from the previous action will be used" }, "vm_action_id": { "type": "integer", "description": "The ID of the action from which the VM will be used", "format": "int32" }, "vm_action_name": { "type": "string", "description": "The name of the action from which the VM will be used" }, "instance_type": { "type": "string", "description": "The type of instance to use for the native build", "enum": [ "GENERAL_MEDIUM", "GENERAL_LARGE", "GENERAL_XLARGE", "GENERAL_2XLARGE", "COMPUTE_MEDIUM", "COMPUTE_LARGE", "COMPUTE_XLARGE", "COMPUTE_2XLARGE", "ARM_GENERAL_MEDIUM", "ARM_GENERAL_LARGE", "ARM_GENERAL_XLARGE", "ARM_GENERAL_2XLARGE", "ARM_COMPUTE_MEDIUM", "ARM_COMPUTE_LARGE", "ARM_COMPUTE_XLARGE", "ARM_COMPUTE_2XLARGE" ] }, "xcode_version": { "type": "string", "description": "The version of Xcode to use" }, "pre_start_simulators": { "type": "array", "description": "The list of simulators to start before the build", "items": { "type": "string", "description": "The list of simulators to start before the build" } }, "node_version": { "type": "string", "description": "The version of Node.js to use" }, "flutter_version": { "type": "string", "description": "The version of Flutter to use" }, "archive_location": { "type": "string", "description": "The path to the archive location" }, "certificates": { "type": "array", "description": "The list of certificates to use for signing", "items": { "type": "string", "description": "The list of certificates to use for signing" } }, "provision_profiles": { "type": "array", "description": "The list of provisioning profiles to use", "items": { "type": "string", "description": "The list of provisioning profiles to use" } }, "sign_mode": { "type": "string", "description": "The signing mode", "enum": [ "MANUAL", "AUTOMATIC" ] }, "distribution_method": { "type": "string", "description": "The distribution method", "enum": [ "APP_STORE", "AD_HOC", "DEVELOPMENT", "ENTERPRISE" ] }, "export_location": { "type": "string", "description": "The path to export the signed app" }, "property_list_source": { "type": "string", "description": "The source of the property list", "enum": [ "GENERATED", "PIPELINE_VOLUME", "VARIABLE", "ACTION" ] }, "property_list": { "type": "string", "description": "The content of the property list" }, "validate_before_upload": { "type": "boolean", "description": "If set to `true`, the app will be validated before upload" }, "submit_for_review": { "type": "boolean", "description": "If set to `true`, the app will be submitted for review" }, "skip_metadata": { "type": "boolean", "description": "If set to `true`, metadata will not be uploaded" }, "skip_app_version_update": { "type": "boolean", "description": "If set to `true`, the app version will not be updated" }, "skip_screenshots": { "type": "boolean", "description": "If set to `true`, screenshots will not be uploaded" }, "integration": { "$ref": "#/components/schemas/AppStoreIntegrationRef" } }, "x-name": "Deploy to App Store Connect" }, "MacFastlaneNativeBuildActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "working_directory": { "type": "string", "description": "The directory in which the pipeline filesystem will be mounted" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "commands": { "type": "array", "description": "The commands to execute in the native build environment", "items": { "type": "string", "description": "The commands to execute in the native build environment" } }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "vm_from_prev_action": { "type": "boolean", "description": "If set to `true`, the VM from the previous action will be used" }, "vm_action_id": { "type": "integer", "description": "The ID of the action from which the VM will be used", "format": "int32" }, "vm_action_name": { "type": "string", "description": "The name of the action from which the VM will be used" }, "instance_type": { "type": "string", "description": "The type of instance to use for the native build", "enum": [ "GENERAL_MEDIUM", "GENERAL_LARGE", "GENERAL_XLARGE", "GENERAL_2XLARGE", "COMPUTE_MEDIUM", "COMPUTE_LARGE", "COMPUTE_XLARGE", "COMPUTE_2XLARGE", "ARM_GENERAL_MEDIUM", "ARM_GENERAL_LARGE", "ARM_GENERAL_XLARGE", "ARM_GENERAL_2XLARGE", "ARM_COMPUTE_MEDIUM", "ARM_COMPUTE_LARGE", "ARM_COMPUTE_XLARGE", "ARM_COMPUTE_2XLARGE" ] }, "xcode_version": { "type": "string", "description": "The version of Xcode to use" }, "pre_start_simulators": { "type": "array", "description": "The list of simulators to start before the build", "items": { "type": "string", "description": "The list of simulators to start before the build" } }, "node_version": { "type": "string", "description": "The version of Node.js to use" }, "flutter_version": { "type": "string", "description": "The version of Flutter to use" }, "archive_location": { "type": "string", "description": "The path to the archive location" }, "certificates": { "type": "array", "description": "The list of certificates to use for signing", "items": { "type": "string", "description": "The list of certificates to use for signing" } }, "provision_profiles": { "type": "array", "description": "The list of provisioning profiles to use", "items": { "type": "string", "description": "The list of provisioning profiles to use" } }, "sign_mode": { "type": "string", "description": "The signing mode", "enum": [ "MANUAL", "AUTOMATIC" ] }, "distribution_method": { "type": "string", "description": "The distribution method", "enum": [ "APP_STORE", "AD_HOC", "DEVELOPMENT", "ENTERPRISE" ] }, "export_location": { "type": "string", "description": "The path to export the signed app" }, "property_list_source": { "type": "string", "description": "The source of the property list", "enum": [ "GENERATED", "PIPELINE_VOLUME", "VARIABLE", "ACTION" ] }, "property_list": { "type": "string", "description": "The content of the property list" }, "validate_before_upload": { "type": "boolean", "description": "If set to `true`, the app will be validated before upload" }, "submit_for_review": { "type": "boolean", "description": "If set to `true`, the app will be submitted for review" }, "skip_metadata": { "type": "boolean", "description": "If set to `true`, metadata will not be uploaded" }, "skip_app_version_update": { "type": "boolean", "description": "If set to `true`, the app version will not be updated" }, "skip_screenshots": { "type": "boolean", "description": "If set to `true`, screenshots will not be uploaded" }, "sync_paths": { "type": "array", "description": "Define file paths that should be copied before (`PIPELINE_TO_VM`) and after the execution (`VM_TO_PIPELINE`).", "items": { "$ref": "#/components/schemas/SyncPathView" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] } }, "x-name": "Build a Fastlane App (iOS)" }, "MacFlutterNativeBuildActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "working_directory": { "type": "string", "description": "The directory in which the pipeline filesystem will be mounted" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "commands": { "type": "array", "description": "The commands to execute in the native build environment", "items": { "type": "string", "description": "The commands to execute in the native build environment" } }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "vm_from_prev_action": { "type": "boolean", "description": "If set to `true`, the VM from the previous action will be used" }, "vm_action_id": { "type": "integer", "description": "The ID of the action from which the VM will be used", "format": "int32" }, "vm_action_name": { "type": "string", "description": "The name of the action from which the VM will be used" }, "instance_type": { "type": "string", "description": "The type of instance to use for the native build", "enum": [ "GENERAL_MEDIUM", "GENERAL_LARGE", "GENERAL_XLARGE", "GENERAL_2XLARGE", "COMPUTE_MEDIUM", "COMPUTE_LARGE", "COMPUTE_XLARGE", "COMPUTE_2XLARGE", "ARM_GENERAL_MEDIUM", "ARM_GENERAL_LARGE", "ARM_GENERAL_XLARGE", "ARM_GENERAL_2XLARGE", "ARM_COMPUTE_MEDIUM", "ARM_COMPUTE_LARGE", "ARM_COMPUTE_XLARGE", "ARM_COMPUTE_2XLARGE" ] }, "xcode_version": { "type": "string", "description": "The version of Xcode to use" }, "pre_start_simulators": { "type": "array", "description": "The list of simulators to start before the build", "items": { "type": "string", "description": "The list of simulators to start before the build" } }, "node_version": { "type": "string", "description": "The version of Node.js to use" }, "flutter_version": { "type": "string", "description": "The version of Flutter to use" }, "archive_location": { "type": "string", "description": "The path to the archive location" }, "certificates": { "type": "array", "description": "The list of certificates to use for signing", "items": { "type": "string", "description": "The list of certificates to use for signing" } }, "provision_profiles": { "type": "array", "description": "The list of provisioning profiles to use", "items": { "type": "string", "description": "The list of provisioning profiles to use" } }, "sign_mode": { "type": "string", "description": "The signing mode", "enum": [ "MANUAL", "AUTOMATIC" ] }, "distribution_method": { "type": "string", "description": "The distribution method", "enum": [ "APP_STORE", "AD_HOC", "DEVELOPMENT", "ENTERPRISE" ] }, "export_location": { "type": "string", "description": "The path to export the signed app" }, "property_list_source": { "type": "string", "description": "The source of the property list", "enum": [ "GENERATED", "PIPELINE_VOLUME", "VARIABLE", "ACTION" ] }, "property_list": { "type": "string", "description": "The content of the property list" }, "validate_before_upload": { "type": "boolean", "description": "If set to `true`, the app will be validated before upload" }, "submit_for_review": { "type": "boolean", "description": "If set to `true`, the app will be submitted for review" }, "skip_metadata": { "type": "boolean", "description": "If set to `true`, metadata will not be uploaded" }, "skip_app_version_update": { "type": "boolean", "description": "If set to `true`, the app version will not be updated" }, "skip_screenshots": { "type": "boolean", "description": "If set to `true`, screenshots will not be uploaded" }, "sync_paths": { "type": "array", "description": "Define file paths that should be copied before (`PIPELINE_TO_VM`) and after the execution (`VM_TO_PIPELINE`).", "items": { "$ref": "#/components/schemas/SyncPathView" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] } }, "x-name": "Build a Flutter App (iOS)" }, "MacNativeBuildActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "working_directory": { "type": "string", "description": "The directory in which the pipeline filesystem will be mounted" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "commands": { "type": "array", "description": "The commands to execute in the native build environment", "items": { "type": "string", "description": "The commands to execute in the native build environment" } }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "vm_from_prev_action": { "type": "boolean", "description": "If set to `true`, the VM from the previous action will be used" }, "vm_action_id": { "type": "integer", "description": "The ID of the action from which the VM will be used", "format": "int32" }, "vm_action_name": { "type": "string", "description": "The name of the action from which the VM will be used" }, "instance_type": { "type": "string", "description": "The type of instance to use for the native build", "enum": [ "GENERAL_MEDIUM", "GENERAL_LARGE", "GENERAL_XLARGE", "GENERAL_2XLARGE", "COMPUTE_MEDIUM", "COMPUTE_LARGE", "COMPUTE_XLARGE", "COMPUTE_2XLARGE", "ARM_GENERAL_MEDIUM", "ARM_GENERAL_LARGE", "ARM_GENERAL_XLARGE", "ARM_GENERAL_2XLARGE", "ARM_COMPUTE_MEDIUM", "ARM_COMPUTE_LARGE", "ARM_COMPUTE_XLARGE", "ARM_COMPUTE_2XLARGE" ] }, "xcode_version": { "type": "string", "description": "The version of Xcode to use" }, "pre_start_simulators": { "type": "array", "description": "The list of simulators to start before the build", "items": { "type": "string", "description": "The list of simulators to start before the build" } }, "node_version": { "type": "string", "description": "The version of Node.js to use" }, "flutter_version": { "type": "string", "description": "The version of Flutter to use" }, "archive_location": { "type": "string", "description": "The path to the archive location" }, "certificates": { "type": "array", "description": "The list of certificates to use for signing", "items": { "type": "string", "description": "The list of certificates to use for signing" } }, "provision_profiles": { "type": "array", "description": "The list of provisioning profiles to use", "items": { "type": "string", "description": "The list of provisioning profiles to use" } }, "sign_mode": { "type": "string", "description": "The signing mode", "enum": [ "MANUAL", "AUTOMATIC" ] }, "distribution_method": { "type": "string", "description": "The distribution method", "enum": [ "APP_STORE", "AD_HOC", "DEVELOPMENT", "ENTERPRISE" ] }, "export_location": { "type": "string", "description": "The path to export the signed app" }, "property_list_source": { "type": "string", "description": "The source of the property list", "enum": [ "GENERATED", "PIPELINE_VOLUME", "VARIABLE", "ACTION" ] }, "property_list": { "type": "string", "description": "The content of the property list" }, "validate_before_upload": { "type": "boolean", "description": "If set to `true`, the app will be validated before upload" }, "submit_for_review": { "type": "boolean", "description": "If set to `true`, the app will be submitted for review" }, "skip_metadata": { "type": "boolean", "description": "If set to `true`, metadata will not be uploaded" }, "skip_app_version_update": { "type": "boolean", "description": "If set to `true`, the app version will not be updated" }, "skip_screenshots": { "type": "boolean", "description": "If set to `true`, screenshots will not be uploaded" }, "sync_paths": { "type": "array", "description": "Define file paths that should be copied before (`PIPELINE_TO_VM`) and after the execution (`VM_TO_PIPELINE`).", "items": { "$ref": "#/components/schemas/SyncPathView" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] } }, "x-name": "Xcode" }, "MacReactNativeBuildActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "working_directory": { "type": "string", "description": "The directory in which the pipeline filesystem will be mounted" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "commands": { "type": "array", "description": "The commands to execute in the native build environment", "items": { "type": "string", "description": "The commands to execute in the native build environment" } }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "vm_from_prev_action": { "type": "boolean", "description": "If set to `true`, the VM from the previous action will be used" }, "vm_action_id": { "type": "integer", "description": "The ID of the action from which the VM will be used", "format": "int32" }, "vm_action_name": { "type": "string", "description": "The name of the action from which the VM will be used" }, "instance_type": { "type": "string", "description": "The type of instance to use for the native build", "enum": [ "GENERAL_MEDIUM", "GENERAL_LARGE", "GENERAL_XLARGE", "GENERAL_2XLARGE", "COMPUTE_MEDIUM", "COMPUTE_LARGE", "COMPUTE_XLARGE", "COMPUTE_2XLARGE", "ARM_GENERAL_MEDIUM", "ARM_GENERAL_LARGE", "ARM_GENERAL_XLARGE", "ARM_GENERAL_2XLARGE", "ARM_COMPUTE_MEDIUM", "ARM_COMPUTE_LARGE", "ARM_COMPUTE_XLARGE", "ARM_COMPUTE_2XLARGE" ] }, "xcode_version": { "type": "string", "description": "The version of Xcode to use" }, "pre_start_simulators": { "type": "array", "description": "The list of simulators to start before the build", "items": { "type": "string", "description": "The list of simulators to start before the build" } }, "node_version": { "type": "string", "description": "The version of Node.js to use" }, "flutter_version": { "type": "string", "description": "The version of Flutter to use" }, "archive_location": { "type": "string", "description": "The path to the archive location" }, "certificates": { "type": "array", "description": "The list of certificates to use for signing", "items": { "type": "string", "description": "The list of certificates to use for signing" } }, "provision_profiles": { "type": "array", "description": "The list of provisioning profiles to use", "items": { "type": "string", "description": "The list of provisioning profiles to use" } }, "sign_mode": { "type": "string", "description": "The signing mode", "enum": [ "MANUAL", "AUTOMATIC" ] }, "distribution_method": { "type": "string", "description": "The distribution method", "enum": [ "APP_STORE", "AD_HOC", "DEVELOPMENT", "ENTERPRISE" ] }, "export_location": { "type": "string", "description": "The path to export the signed app" }, "property_list_source": { "type": "string", "description": "The source of the property list", "enum": [ "GENERATED", "PIPELINE_VOLUME", "VARIABLE", "ACTION" ] }, "property_list": { "type": "string", "description": "The content of the property list" }, "validate_before_upload": { "type": "boolean", "description": "If set to `true`, the app will be validated before upload" }, "submit_for_review": { "type": "boolean", "description": "If set to `true`, the app will be submitted for review" }, "skip_metadata": { "type": "boolean", "description": "If set to `true`, metadata will not be uploaded" }, "skip_app_version_update": { "type": "boolean", "description": "If set to `true`, the app version will not be updated" }, "skip_screenshots": { "type": "boolean", "description": "If set to `true`, screenshots will not be uploaded" }, "sync_paths": { "type": "array", "description": "Define file paths that should be copied before (`PIPELINE_TO_VM`) and after the execution (`VM_TO_PIPELINE`).", "items": { "$ref": "#/components/schemas/SyncPathView" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] } }, "x-name": "Build a React Native App" }, "MacSignNativeBuildActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "working_directory": { "type": "string", "description": "The directory in which the pipeline filesystem will be mounted" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "commands": { "type": "array", "description": "The commands to execute in the native build environment", "items": { "type": "string", "description": "The commands to execute in the native build environment" } }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "vm_from_prev_action": { "type": "boolean", "description": "If set to `true`, the VM from the previous action will be used" }, "vm_action_id": { "type": "integer", "description": "The ID of the action from which the VM will be used", "format": "int32" }, "vm_action_name": { "type": "string", "description": "The name of the action from which the VM will be used" }, "instance_type": { "type": "string", "description": "The type of instance to use for the native build", "enum": [ "GENERAL_MEDIUM", "GENERAL_LARGE", "GENERAL_XLARGE", "GENERAL_2XLARGE", "COMPUTE_MEDIUM", "COMPUTE_LARGE", "COMPUTE_XLARGE", "COMPUTE_2XLARGE", "ARM_GENERAL_MEDIUM", "ARM_GENERAL_LARGE", "ARM_GENERAL_XLARGE", "ARM_GENERAL_2XLARGE", "ARM_COMPUTE_MEDIUM", "ARM_COMPUTE_LARGE", "ARM_COMPUTE_XLARGE", "ARM_COMPUTE_2XLARGE" ] }, "xcode_version": { "type": "string", "description": "The version of Xcode to use" }, "pre_start_simulators": { "type": "array", "description": "The list of simulators to start before the build", "items": { "type": "string", "description": "The list of simulators to start before the build" } }, "node_version": { "type": "string", "description": "The version of Node.js to use" }, "flutter_version": { "type": "string", "description": "The version of Flutter to use" }, "archive_location": { "type": "string", "description": "The path to the archive location" }, "certificates": { "type": "array", "description": "The list of certificates to use for signing", "items": { "type": "string", "description": "The list of certificates to use for signing" } }, "provision_profiles": { "type": "array", "description": "The list of provisioning profiles to use", "items": { "type": "string", "description": "The list of provisioning profiles to use" } }, "sign_mode": { "type": "string", "description": "The signing mode", "enum": [ "MANUAL", "AUTOMATIC" ] }, "distribution_method": { "type": "string", "description": "The distribution method", "enum": [ "APP_STORE", "AD_HOC", "DEVELOPMENT", "ENTERPRISE" ] }, "export_location": { "type": "string", "description": "The path to export the signed app" }, "property_list_source": { "type": "string", "description": "The source of the property list", "enum": [ "GENERATED", "PIPELINE_VOLUME", "VARIABLE", "ACTION" ] }, "property_list": { "type": "string", "description": "The content of the property list" }, "validate_before_upload": { "type": "boolean", "description": "If set to `true`, the app will be validated before upload" }, "submit_for_review": { "type": "boolean", "description": "If set to `true`, the app will be submitted for review" }, "skip_metadata": { "type": "boolean", "description": "If set to `true`, metadata will not be uploaded" }, "skip_app_version_update": { "type": "boolean", "description": "If set to `true`, the app version will not be updated" }, "skip_screenshots": { "type": "boolean", "description": "If set to `true`, screenshots will not be uploaded" } }, "x-name": "Code sign and export an iOS app" }, "MacVmNativeBuildActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "working_directory": { "type": "string", "description": "The directory in which the pipeline filesystem will be mounted" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "commands": { "type": "array", "description": "The commands to execute in the native build environment", "items": { "type": "string", "description": "The commands to execute in the native build environment" } }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "vm_from_prev_action": { "type": "boolean", "description": "If set to `true`, the VM from the previous action will be used" }, "vm_action_id": { "type": "integer", "description": "The ID of the action from which the VM will be used", "format": "int32" }, "vm_action_name": { "type": "string", "description": "The name of the action from which the VM will be used" }, "instance_type": { "type": "string", "description": "The type of instance to use for the native build", "enum": [ "GENERAL_MEDIUM", "GENERAL_LARGE", "GENERAL_XLARGE", "GENERAL_2XLARGE", "COMPUTE_MEDIUM", "COMPUTE_LARGE", "COMPUTE_XLARGE", "COMPUTE_2XLARGE", "ARM_GENERAL_MEDIUM", "ARM_GENERAL_LARGE", "ARM_GENERAL_XLARGE", "ARM_GENERAL_2XLARGE", "ARM_COMPUTE_MEDIUM", "ARM_COMPUTE_LARGE", "ARM_COMPUTE_XLARGE", "ARM_COMPUTE_2XLARGE" ] }, "xcode_version": { "type": "string", "description": "The version of Xcode to use" }, "pre_start_simulators": { "type": "array", "description": "The list of simulators to start before the build", "items": { "type": "string", "description": "The list of simulators to start before the build" } }, "node_version": { "type": "string", "description": "The version of Node.js to use" }, "flutter_version": { "type": "string", "description": "The version of Flutter to use" }, "archive_location": { "type": "string", "description": "The path to the archive location" }, "certificates": { "type": "array", "description": "The list of certificates to use for signing", "items": { "type": "string", "description": "The list of certificates to use for signing" } }, "provision_profiles": { "type": "array", "description": "The list of provisioning profiles to use", "items": { "type": "string", "description": "The list of provisioning profiles to use" } }, "sign_mode": { "type": "string", "description": "The signing mode", "enum": [ "MANUAL", "AUTOMATIC" ] }, "distribution_method": { "type": "string", "description": "The distribution method", "enum": [ "APP_STORE", "AD_HOC", "DEVELOPMENT", "ENTERPRISE" ] }, "export_location": { "type": "string", "description": "The path to export the signed app" }, "property_list_source": { "type": "string", "description": "The source of the property list", "enum": [ "GENERATED", "PIPELINE_VOLUME", "VARIABLE", "ACTION" ] }, "property_list": { "type": "string", "description": "The content of the property list" }, "validate_before_upload": { "type": "boolean", "description": "If set to `true`, the app will be validated before upload" }, "submit_for_review": { "type": "boolean", "description": "If set to `true`, the app will be submitted for review" }, "skip_metadata": { "type": "boolean", "description": "If set to `true`, metadata will not be uploaded" }, "skip_app_version_update": { "type": "boolean", "description": "If set to `true`, the app version will not be updated" }, "skip_screenshots": { "type": "boolean", "description": "If set to `true`, screenshots will not be uploaded" }, "sync_paths": { "type": "array", "description": "Define file paths that should be copied before (`PIPELINE_TO_VM`) and after the execution (`VM_TO_PIPELINE`).", "items": { "$ref": "#/components/schemas/SyncPathView" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] } }, "x-name": "MacOS VM" }, "ManageSandboxActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "operation": { "type": "string", "description": "The operation to perform on the sandbox", "enum": [ "START", "STOP", "DELETE", "APP_START", "APP_STOP", "CREATE_SNAPSHOT", "APP_RESTART" ] }, "referenced_action_id": { "type": "integer", "description": "The numerical ID of the referenced action that created or manages the sandbox", "format": "int32" }, "referenced_action_name": { "type": "string", "description": "The name of the referenced action that created or manages the sandbox" }, "snapshot_name": { "type": "string", "description": "The name for the snapshot when `operation` is `CREATE_SNAPSHOT`. Can use Buddy variables like `$BUDDY_RUN_ID`." }, "targets": { "type": "array", "description": "Array of sandbox targets to perform the operation on. Can be specific sandbox names or filters.", "items": { "$ref": "#/components/schemas/TargetView" } } }, "x-name": "Manage sandbox" }, "MicrosoftTeamsActionRequest": { "required": [ "content", "name", "recipients", "title", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "title": { "type": "string", "description": "The title of the notification." }, "content": { "type": "string", "description": "The content of the notification." }, "recipients": { "type": "string", "description": "The recipient of the notification: email address." }, "send_as_html": { "type": "boolean", "description": "Defines whether to send the content as HTML." }, "file_attachments": { "type": "array", "description": "The attached files.", "items": { "type": "string", "description": "The attached files." } } }, "x-name": "Microsoft Teams" }, "MongoshCliActionRequest": { "required": [ "execute_commands", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "version": { "type": "string", "description": "The version of the MongoDB Docker image. Default: `latest`" }, "targets": { "type": "array", "description": "The list of MongoDB targets for this action", "items": { "$ref": "#/components/schemas/TargetView" } } }, "x-name": "Mongosh CLI" }, "MssqlCliActionRequest": { "required": [ "execute_commands", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "targets": { "type": "array", "description": "The list of MSSQL targets for this action", "items": { "$ref": "#/components/schemas/TargetView" } } }, "x-name": "MSSQL CLI" }, "MysqlCliActionRequest": { "required": [ "execute_commands", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "version": { "type": "string", "description": "The version of the MySQL Docker image. Default: `latest`" }, "targets": { "type": "array", "description": "The list of MySQL targets for this action", "items": { "$ref": "#/components/schemas/TargetView" } } }, "x-name": "MySQL CLI" }, "NetlifyActionRequest": { "required": [ "execute_commands", "integration", "name", "site_id", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/NetlifyIntegrationRef" }, "site_id": { "type": "string", "description": "The API ID in the site details." }, "version": { "type": "string", "description": "The version of the Netlify CLI to use" } }, "x-name": "Netlify" }, "NetlifyIntegrationRef": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" } }, "description": "Netlify integration (NETLIFY)" }, "NewRelicActionRequest": { "required": [ "application_id", "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "integration": { "$ref": "#/components/schemas/NewRelicIntegrationRef" }, "changelog": { "type": "string", "description": "The content of the notification." }, "description": { "type": "string", "description": "The title of the notification." }, "application_id": { "type": "string", "description": "The ID of the New Relic application." }, "version": { "type": "string", "description": "The revision to which the application is deployed. If not set, the default value is $BUDDY_RUN_COMMIT." }, "region": { "type": "string", "description": "The New Relic region. Can be one of `US` or `EU`." } }, "description": "This action type is deprecated. Please use NEW_RELIC_CLI action instead.", "deprecated": true, "x-name": "New Relic" }, "NewRelicCliActionRequest": { "required": [ "execute_commands", "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/NewRelicIntegrationRef" } }, "x-name": "New Relic CLI" }, "NewRelicIntegrationRef": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" } }, "description": "New Relic integration (NEW_RELIC)" }, "NpmIntegrationRef": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" } }, "description": "The Npm registry integration (NPM)" }, "NpmPublishActionRequest": { "required": [ "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "integration": { "$ref": "#/components/schemas/NpmIntegrationRef" }, "npm_registry": { "type": "string", "description": "The NPM registry to use for publishing the artifact", "enum": [ "NPM", "GIT_HUB", "OTHER" ] }, "access": { "type": "string", "description": "Whether artifact has public or restricted access", "enum": [ "RESTRICTED", "PUBLIC" ] }, "ignore_scripts": { "type": "boolean", "description": "If set to `true`, lifecycle scripts will not be executed during publish" }, "tag": { "type": "string", "description": "The distribution tag to use when publishing the artifact" }, "source_path": { "type": "string", "description": "The path to the artifact directory to publish" }, "registry": { "type": "string", "description": "The custom NPM registry URL to use for publishing" }, "token": { "type": "string", "description": "The authentication token for the NPM registry" } }, "x-name": "Npm Publish" }, "Parameter": { "type": "object", "properties": { "key": { "type": "string", "description": "The key/name of the parameter" }, "value": { "type": "string", "description": "The value of the parameter" } }, "description": "The list of parameters to send with the ATOP notification" }, "PingActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "destination": { "type": "string", "description": "The destination address for the network action" } }, "x-name": "Ping monitoring" }, "PipelineReferenceRequest": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "identifier": { "type": "string", "description": "A human-readable ID of pipeline" }, "project": { "$ref": "#/components/schemas/ProjectNameView" }, "id": { "type": "integer", "description": "The unique ID of the pipeline", "format": "int32" }, "name": { "type": "string", "description": "The name of the pipeline" } }, "description": "The target pipeline whose settings will be modified" }, "PipelineSettingsActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "cron": { "type": "string", "description": "The cron expression that defines the schedule for running the pipeline" }, "target_pipeline": { "$ref": "#/components/schemas/PipelineReferenceRequest" } }, "x-name": "Pipeline Settings" }, "PlaywrightActionRequest": { "required": [ "docker_image_name", "docker_image_tag", "execute_commands", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "working_directory": { "type": "string", "description": "The directory in which the pipeline filesystem will be mounted" }, "main_service_name": { "type": "string", "description": "The hostname of the container in which the action is run. The container will be available under this name in the docker network for services" }, "run_as_user": { "type": "string", "description": "All build commands are run as the default user defined in the selected Docker image. Can be set to another username (on the condition that this user exists in the selected image)" }, "version": { "type": "string", "description": "The version of the artifact from artifact registry" }, "docker_image_name": { "type": "string", "description": "The name of the Docker image" }, "docker_image_tag": { "type": "string", "description": "The tag of the Docker image" }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "mount_filesystem_disable": { "type": "boolean", "description": "If set to `true`, the filesystem will not be mounted in the container" }, "volume_mappings": { "type": "array", "description": "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)", "items": { "type": "string", "description": "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)" } }, "cached_dirs": { "type": "array", "description": "The dependencies & directories to be cached and available to every execution in this pipeline", "items": { "type": "string", "description": "The dependencies & directories to be cached and available to every execution in this pipeline" } }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "services": { "type": "array", "description": "The list of services attached to the build environment", "items": { "$ref": "#/components/schemas/ServiceView" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "registry": { "type": "string", "description": "The URL of the Docker registry" }, "insecure_registry": { "type": "boolean", "description": "If set to `true`, the registry will be accessed over HTTP instead of HTTPS" }, "login": { "type": "string", "description": "The username for the Docker registry" }, "target_stage": { "type": "string", "description": "The target stage of the Dockerfile" }, "password": { "type": "string", "description": "The password for the Docker registry" }, "region": { "type": "string", "description": "The region for the Docker registry (for AWS ECR)" }, "image_location": { "type": "string", "description": "The location of the image used by the action", "enum": [ "PUBLIC_REGISTRY", "PRIVATE_REGISTRY", "ACTION", "ARTIFACT_REGISTRY" ] }, "use_image_from_action": { "type": "boolean", "description": "If set to `true`, the image from another action will be used" }, "docker_registry": { "type": "string", "description": "The type of registry from which the image is retrieved", "enum": [ "NONE", "DOCKER_HUB", "AMAZON_ECR", "GOOGLE_GCR", "GOOGLE_ARTIFACT_REGISTRY", "OTHER", "GIT_HUB_CONTAINER_REGISTRY", "ARTIFACT_REGISTRY", "DIGITAL_OCEAN_CONTAINER_REGISTRY" ] }, "docker_build_action_id": { "type": "integer", "description": "The ID of the action from which the Docker image will be used", "format": "int32" }, "docker_build_action_name": { "type": "string", "description": "The name of the action from which the Docker image will be used" }, "export_container_path": { "type": "string", "description": "The path in the container to export" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "ignore_image_pull_failures": { "type": "boolean", "description": "If set to `true`, use cached image on timeouts (only for official images)" }, "reset_entrypoint": { "type": "boolean", "description": "If set to `true`, resets the default entrypoint set by the image. Default value: `false`" }, "username": { "type": "string", "description": "The username for authentication" }, "cache_base_image": { "type": "boolean", "description": "If set to `true`, the cached version of the image is used, instead of being pulled each time" }, "do_not_prune_images": { "type": "boolean", "description": "If set to `true`, images will not be pruned after the build" }, "vt_suite": { "type": "string", "description": "The visual tests suite identifier" }, "unit_tests_suite": { "type": "string", "description": "The unit tests suite identifier" }, "unit_tests_path": { "type": "string", "description": "The path to the unit tests results" }, "integration": { "$ref": "#/components/schemas/DockerIntegrationRef" }, "artifact": { "type": "string", "description": "The identifier of the artifact from artifact registry" } }, "x-name": "Playwright" }, "PostgresqlCliActionRequest": { "required": [ "execute_commands", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "version": { "type": "string", "description": "The version of the PostgreSQL Docker image. Default: `latest`" }, "targets": { "type": "array", "description": "The list of PostgreSQL targets for this action", "items": { "$ref": "#/components/schemas/TargetView" } } }, "x-name": "PostgreSQL CLI" }, "PowershellActionRequest": { "required": [ "commands", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "working_directory": { "type": "string", "description": "The directory in which the PowerShell commands will be executed" }, "commands": { "type": "array", "description": "The PowerShell commands that will be executed", "items": { "type": "string", "description": "The PowerShell commands that will be executed" } }, "shell": { "type": "string", "description": "The shell type used for command execution" }, "execute_every_command": { "type": "boolean", "description": "If set to `true`, executes every command regardless of previous command failures" }, "run_as_script": { "type": "boolean", "description": "If set to `true`, commands will be executed as a PowerShell script" }, "targets": { "type": "array", "description": "The list of target servers where the PowerShell commands will be executed", "items": { "$ref": "#/components/schemas/TargetView" } } }, "x-name": "Powershell Command" }, "ProjectNameView": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "The human-readable ID of the project" } }, "description": "Project reference (by name)" }, "ProjectView": { "required": [ "display_name" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "name": { "type": "string", "description": "The human-readable ID of the project", "example": "my-project" }, "display_name": { "type": "string", "description": "The Name of the project", "example": "My Project" }, "status": { "type": "string", "description": "The status of the project" }, "access": { "type": "string", "description": "Indicates if this is a public project", "enum": [ "PRIVATE", "PUBLIC" ] }, "create_date": { "type": "string", "description": "The creation date of the project", "format": "date-time" }, "external_project_id": { "type": "string", "description": "Repo slug of the Bitbucket, GitHub or GitLab project. Required when adding the integrated project" }, "git_lab_project_id": { "type": "integer", "description": "ID of the project in GitLab", "format": "int32" }, "custom_repo_url": { "type": "string", "description": "SSH or HTTPS url of the git repository. Required when adding the project integrated with custom git repository" }, "custom_repo_user": { "type": "string", "description": "Username used to authorize access to the git repository. Required when adding the project integrated with custom git repository" }, "custom_repo_pass": { "type": "string", "description": "Password used to authorize access to the git repository. Required when adding the project integrated with custom git repository and the provided `custom_repo_url` is the HTTPS url" }, "custom_repo_ssh_key_id": { "type": "integer", "description": "The ID of the private SSH key used to authorize access to the git repository. Required when adding the project integrated with private git server by SSH url", "format": "int32" }, "created_by": { "$ref": "#/components/schemas/MemberView" }, "http_repository": { "type": "string", "description": "The HTTP repository URL" }, "ssh_repository": { "type": "string", "description": "The SSH repository URL" }, "default_branch": { "type": "string", "description": "The default branch name" }, "integration": { "$ref": "#/components/schemas/IntegrationIdView" }, "fetch_submodules": { "type": "boolean", "description": "Defines whether the submodules are fetched during the runs in this project" }, "fetch_submodules_env_key": { "type": "string", "description": "Name of the key that will be used to authorize while fetching the submodules. Required when `fetch_submodules` is set to `true`" }, "allow_pull_requests": { "type": "boolean", "description": "Enables/disables pull requests in the project. Available only for projects synchronized with GitHub or GitHub Enterprise repository" }, "update_default_branch_from_external": { "type": "boolean", "description": "If set to true, the default branch will be updated from GitHub/GitLab/Bitbucket." }, "without_repository": { "type": "boolean", "description": "If set to true, the project is created without any repository attached." } } }, "PromoteImageActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "same_location": { "type": "boolean", "description": "If set to `true`, promotes the image within the same registry (only tag changes). If `false`, promotes between different registries." }, "src": { "$ref": "#/components/schemas/PromoteImageView" }, "dest": { "$ref": "#/components/schemas/PromoteImageView" }, "insecure_registry": { "type": "boolean", "description": "If set to `true`, allows connection to insecure Docker registries" } }, "x-name": "Tag Docker Image" }, "PromoteImageView": { "type": "object", "properties": { "docker_registry": { "type": "string", "description": "The type of Docker registry", "enum": [ "NONE", "DOCKER_HUB", "AMAZON_ECR", "GOOGLE_GCR", "GOOGLE_ARTIFACT_REGISTRY", "OTHER", "GIT_HUB_CONTAINER_REGISTRY", "ARTIFACT_REGISTRY", "DIGITAL_OCEAN_CONTAINER_REGISTRY" ] }, "registry": { "type": "string", "description": "The Docker registry URL" }, "image": { "type": "string", "description": "The name of the Docker image to promote" }, "tag": { "type": "string", "description": "The tag of the Docker image to promote" }, "username": { "type": "string", "description": "The username for Docker registry authentication" }, "password": { "type": "string", "description": "The password for Docker registry authentication" }, "integration": { "type": "string", "description": "The identifier of the integration to use for authentication" }, "region": { "type": "string", "description": "The region for cloud-based Docker registries (e.g., AWS ECR)" } }, "description": "The destination Docker image location" }, "PublishArtifactVersionActionRequest": { "required": [ "local_path", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The current git revision" }, "local_path": { "type": "string", "description": "The path to the local files to deploy" }, "remote_path": { "type": "string", "description": "The path on the remote server where files will be deployed" }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "deployment_includes": { "type": "array", "description": "The list of files or directories to include in deployment", "items": { "type": "string", "description": "The list of files or directories to include in deployment" } }, "input_type": { "type": "string", "description": "The type of source input", "enum": [ "SCM_REPOSITORY", "BUILD_ARTIFACTS" ] }, "deletion_disabled": { "type": "boolean", "description": "If set to `true`, files on the remote server will not be deleted" }, "use_temporary_files": { "type": "boolean", "description": "If set to `true`, files will be uploaded to a temporary directory first" }, "content_encoding": { "type": "string", "description": "The content encoding for deployed files" }, "versions": { "type": "array", "description": "The list of artifact versions to publish", "items": { "type": "string", "description": "The list of artifact versions to publish" } }, "artifact": { "type": "string", "description": "The human-readable ID of the artifact to publish" } }, "x-name": "Publish Artifact Version" }, "PushActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "push_tags": { "type": "boolean", "description": "If set to `true`, tags will be pushed to the repository" }, "push_only_tags": { "type": "boolean", "description": "If set to `true`, only tags will be pushed without commits" }, "target_branch": { "type": "string", "description": "The target branch to push to" }, "without_force": { "type": "boolean", "description": "If set to `true`, force push will not be used" }, "isolated": { "type": "boolean", "description": "If set to `true`, the action will run in an isolated environment" }, "use_custom_gitignore": { "type": "boolean", "description": "If set to `true`, custom .gitignore rules will be used" }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "comment": { "type": "string", "description": "The commit message for the push" }, "tag": { "type": "string", "description": "The tag name to create and push" }, "custom_options": { "type": "string", "description": "Custom git push options" }, "targets": { "type": "array", "description": "The list of target repositories to push to", "items": { "$ref": "#/components/schemas/TargetView" } }, "commiter_email": { "type": "string", "description": "The email address of the committer" }, "signing_asset": { "type": "string", "description": "The name of the asset used for signing the commit" } }, "x-name": "Git Push" }, "PushbulletActionRequest": { "required": [ "content", "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "integration": { "$ref": "#/components/schemas/PushbulletIntegrationRef" }, "content": { "type": "string", "description": "The content of the notification." }, "title": { "type": "string", "description": "The title of the notification." }, "link": { "type": "string", "description": "The link of the notification." }, "device": { "type": "string", "description": "The name of the device to which the notification will be sent." } }, "x-name": "Pushbullet" }, "PushbulletIntegrationRef": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" } }, "description": "Pushbullet integration (PUSHBULLET)" }, "PushoverActionRequest": { "required": [ "content", "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "integration": { "$ref": "#/components/schemas/PushoverIntegrationRef" }, "content": { "type": "string", "description": "The content of the notification." }, "title": { "type": "string", "description": "The title of the notification." }, "link": { "type": "string", "description": "The link of the notification." }, "link_title": { "type": "string", "description": "The title of the notification link." }, "priority": { "type": "string", "description": "Specifies the priority of the notification. Can be one of `LOW`, `NORMAL` or `HIGH`." }, "device": { "type": "string", "description": "The name of the device to which the notification will be sent." } }, "x-name": "Pushover" }, "PushoverIntegrationRef": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" } }, "description": "Pushover integration (PUSHOVER)" }, "RackspaceActionRequest": { "required": [ "container", "integration", "local_path", "name", "region", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The current git revision" }, "local_path": { "type": "string", "description": "The path to the local files to deploy" }, "remote_path": { "type": "string", "description": "The path on the remote server where files will be deployed" }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "deployment_includes": { "type": "array", "description": "The list of files or directories to include in deployment", "items": { "type": "string", "description": "The list of files or directories to include in deployment" } }, "input_type": { "type": "string", "description": "The type of source input", "enum": [ "SCM_REPOSITORY", "BUILD_ARTIFACTS" ] }, "deletion_disabled": { "type": "boolean", "description": "If set to `true`, files on the remote server will not be deleted" }, "use_temporary_files": { "type": "boolean", "description": "If set to `true`, files will be uploaded to a temporary directory first" }, "content_encoding": { "type": "string", "description": "The content encoding for deployed files" }, "integration": { "$ref": "#/components/schemas/RackspaceIntegrationRef" }, "region": { "type": "string", "description": "The name of the Rackspace region." }, "container": { "type": "string", "description": "The name of the Rackspace container." } }, "x-name": "Rackspace" }, "RackspaceIntegrationRef": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" } }, "description": "Rackspace integration (RACKSPACE)" }, "RaygunActionRequest": { "required": [ "name", "token", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "token": { "type": "string", "description": "See `authToken` [here](https://raygun.com/documentation/product-guides/deployment-tracking/deployments-api/)." }, "api_key": { "type": "string", "description": "See `apiKey` [here](https://raygun.com/documentation/product-guides/deployment-tracking/deployments-api/)." }, "version": { "type": "string", "description": "See `version` [here](https://raygun.com/documentation/product-guides/deployment-tracking/deployments-api/)." }, "user": { "type": "string", "description": "See `ownerName` [here](https://raygun.com/documentation/product-guides/deployment-tracking/deployments-api/)." }, "email": { "type": "string", "description": "See `emailAddress` [here](https://raygun.com/documentation/product-guides/deployment-tracking/deployments-api/)." }, "comment": { "type": "string", "description": "See `comment` [here](https://raygun.com/documentation/product-guides/deployment-tracking/deployments-api/)." } }, "x-name": "Raygun" }, "ReplaceActionRequest": { "required": [ "local_path", "name", "replacements", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "local_path": { "type": "string", "description": "The path in the repository." }, "replacements": { "type": "array", "description": "The list of pairs of strings for replacement.", "items": { "$ref": "#/components/schemas/ReplacementView" } } }, "x-name": "Replace" }, "ReplacementView": { "type": "object", "properties": { "replace_from": { "type": "string", "description": "The text or pattern to search for" }, "replace_to": { "type": "string", "description": "The text to replace with" } }, "description": "The list of pairs of strings for replacement." }, "RollbarActionRequest": { "required": [ "environment", "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "integration": { "$ref": "#/components/schemas/RollbarIntegrationRef" }, "application": { "type": "string", "description": "The name of the Rollbar application" }, "comment": { "type": "string", "description": "The deployment comment" }, "rollbar_username": { "type": "string", "description": "The Rollbar username for the deployment" }, "user": { "type": "string", "description": "The user who initiated the deployment" }, "environment": { "type": "string", "description": "The deployment environment (e.g., production, staging)" } }, "x-name": "Rollbar notification" }, "RollbarIntegrationRef": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" } }, "description": "Rollbar integration (ROLLBAR)" }, "RsyncActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "local_path": { "type": "string", "description": "The path to the local files to synchronize" }, "deployment_excludes": { "type": "array", "description": "The list of paths to exclude from synchronization", "items": { "type": "string", "description": "The list of paths to exclude from synchronization" } }, "deployment_includes": { "type": "array", "description": "The list of paths to include in synchronization", "items": { "type": "string", "description": "The list of paths to include in synchronization" } }, "archive": { "type": "boolean", "description": "Enables archive mode, preserving permissions, timestamps, and symbolic links" }, "delete_extra_files": { "type": "boolean", "description": "Deletes files on the destination that don't exist in the source" }, "recursive": { "type": "boolean", "description": "Synchronizes directories recursively" }, "dirs": { "type": "boolean", "description": "Transfers directories without their contents" }, "compress": { "type": "boolean", "description": "Compresses files during transfer" }, "remote_path": { "type": "string", "description": "The path on the remote server where files will be synchronized" }, "arguments": { "type": "string", "description": "Additional rsync command-line arguments" }, "targets": { "type": "array", "description": "The list of servers to synchronize files to", "items": { "$ref": "#/components/schemas/TargetView" } } }, "x-name": "Rsync" }, "RunDockerContainerActionRequest": { "required": [ "docker_image_name", "docker_image_tag", "execute_commands", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "working_directory": { "type": "string", "description": "The directory in which the pipeline filesystem will be mounted" }, "main_service_name": { "type": "string", "description": "The hostname of the container in which the action is run. The container will be available under this name in the docker network for services" }, "run_as_user": { "type": "string", "description": "All build commands are run as the default user defined in the selected Docker image. Can be set to another username (on the condition that this user exists in the selected image)" }, "version": { "type": "string", "description": "The version of the artifact from artifact registry" }, "docker_image_name": { "type": "string", "description": "The name of the Docker image" }, "docker_image_tag": { "type": "string", "description": "The tag of the Docker image" }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "mount_filesystem_disable": { "type": "boolean", "description": "If set to `true`, the filesystem will not be mounted in the container" }, "volume_mappings": { "type": "array", "description": "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)", "items": { "type": "string", "description": "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)" } }, "cached_dirs": { "type": "array", "description": "The dependencies & directories to be cached and available to every execution in this pipeline", "items": { "type": "string", "description": "The dependencies & directories to be cached and available to every execution in this pipeline" } }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "services": { "type": "array", "description": "The list of services attached to the build environment", "items": { "$ref": "#/components/schemas/ServiceView" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "registry": { "type": "string", "description": "The URL of the Docker registry" }, "insecure_registry": { "type": "boolean", "description": "If set to `true`, the registry will be accessed over HTTP instead of HTTPS" }, "login": { "type": "string", "description": "The username for the Docker registry" }, "target_stage": { "type": "string", "description": "The target stage of the Dockerfile" }, "password": { "type": "string", "description": "The password for the Docker registry" }, "region": { "type": "string", "description": "The region for the Docker registry (for AWS ECR)" }, "image_location": { "type": "string", "description": "The location of the image used by the action", "enum": [ "PUBLIC_REGISTRY", "PRIVATE_REGISTRY", "ACTION", "ARTIFACT_REGISTRY" ] }, "use_image_from_action": { "type": "boolean", "description": "If set to `true`, the image from another action will be used" }, "docker_registry": { "type": "string", "description": "The type of registry from which the image is retrieved", "enum": [ "NONE", "DOCKER_HUB", "AMAZON_ECR", "GOOGLE_GCR", "GOOGLE_ARTIFACT_REGISTRY", "OTHER", "GIT_HUB_CONTAINER_REGISTRY", "ARTIFACT_REGISTRY", "DIGITAL_OCEAN_CONTAINER_REGISTRY" ] }, "docker_build_action_id": { "type": "integer", "description": "The ID of the action from which the Docker image will be used", "format": "int32" }, "docker_build_action_name": { "type": "string", "description": "The name of the action from which the Docker image will be used" }, "export_container_path": { "type": "string", "description": "The path in the container to export" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "ignore_image_pull_failures": { "type": "boolean", "description": "If set to `true`, use cached image on timeouts (only for official images)" }, "reset_entrypoint": { "type": "boolean", "description": "If set to `true`, resets the default entrypoint set by the image. Default value: `false`" }, "username": { "type": "string", "description": "The username for authentication" }, "cache_base_image": { "type": "boolean", "description": "If set to `true`, the cached version of the image is used, instead of being pulled each time" }, "do_not_prune_images": { "type": "boolean", "description": "If set to `true`, images will not be pruned after the build" }, "vt_suite": { "type": "string", "description": "The visual tests suite identifier" }, "unit_tests_suite": { "type": "string", "description": "The unit tests suite identifier" }, "unit_tests_path": { "type": "string", "description": "The path to the unit tests results" }, "integration": { "$ref": "#/components/schemas/DockerIntegrationRef" }, "entrypoint": { "type": "string", "description": "The entrypoint to use for the Docker container" }, "inline_commands": { "type": "string", "description": "The commands to execute inside the Docker container" }, "artifact": { "type": "string", "description": "The identifier of the artifact from artifact registry" } }, "x-name": "Run Docker container" }, "RunNextPipelineActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "comment": { "type": "string", "description": "The comment for the pipeline execution" }, "revision": { "type": "string", "description": "The revision to execute" }, "specific_revision": { "type": "string", "description": "The specific revision identifier to execute" }, "next_pipeline": { "$ref": "#/components/schemas/PipelineReferenceRequest" }, "wait": { "type": "boolean", "description": "Wait for the pipeline execution to complete" }, "clear_cache": { "type": "boolean", "description": "Clear the cache before executing the pipeline" }, "refresh": { "type": "boolean", "description": "Refresh the repository before executing the pipeline" }, "environment": { "type": "string", "description": "The environment for the pipeline execution" }, "priority": { "type": "string", "description": "The priority of the pipeline execution" }, "artifact": { "type": "string", "description": "The artifact context identifier for the pipeline execution" } }, "x-name": "Trigger pipeline" }, "SandboxAppView": { "type": "object", "properties": { "id": { "type": "string", "description": "The auto-generated ID of the app" }, "command": { "type": "string", "description": "The run command of the app" }, "app_status": { "type": "string", "description": "The current status of the app", "enum": [ "NONE", "RUNNING", "ENDED", "FAILED" ] } } }, "SandboxApplicationStartActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "sandbox_id": { "type": "string", "description": "The ID of the sandbox" }, "sandbox_references": { "uniqueItems": true, "type": "array", "description": "The set of sandbox reference types", "items": { "type": "string", "description": "The set of sandbox reference types", "enum": [ "BY_ID", "BY_TAGS", "BY_ACTION", "BY_NAME", "BY_PROJECT", "BY_DAYS" ] } }, "sandbox_project_id": { "type": "integer", "description": "The ID of the sandbox project", "format": "int32" }, "sandbox_project_name": { "type": "string", "description": "The name of the sandbox project" }, "tags": { "uniqueItems": true, "type": "array", "description": "The set of tags for the sandbox", "items": { "type": "string", "description": "The set of tags for the sandbox" } }, "referenced_sandbox_name": { "type": "string", "description": "The name of the referenced sandbox" }, "days": { "type": "integer", "description": "The number of days for sandbox retention", "format": "int32" }, "referenced_action_id": { "type": "integer", "description": "The ID of the referenced action", "format": "int32" }, "referenced_action_name": { "type": "string", "description": "The name of the referenced action" }, "sandbox_name": { "type": "string", "description": "The name of the sandbox" }, "snapshot_name": { "type": "string", "description": "The name of the snapshot" }, "snapshot_id": { "type": "string", "description": "The ID of the snapshot" }, "sandbox_distribution": { "type": "string", "description": "The distribution used for the sandbox" }, "resources": { "type": "string", "description": "The resource allocation for the sandbox", "enum": [ "1x2", "2x4", "3x6", "4x8", "5x10", "6x12", "7x14", "8x16", "9x18", "10x20", "11x22", "12x24", "CUSTOM" ] }, "return_existing": { "type": "boolean", "description": "If set to `true`, an existing sandbox will be returned" } }, "description": "This action type is deprecated. Please use alternative sandbox management actions.", "deprecated": true, "x-name": "Sandbox Application Start" }, "SandboxApplicationStopActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "sandbox_id": { "type": "string", "description": "The ID of the sandbox" }, "sandbox_references": { "uniqueItems": true, "type": "array", "description": "The set of sandbox reference types", "items": { "type": "string", "description": "The set of sandbox reference types", "enum": [ "BY_ID", "BY_TAGS", "BY_ACTION", "BY_NAME", "BY_PROJECT", "BY_DAYS" ] } }, "sandbox_project_id": { "type": "integer", "description": "The ID of the sandbox project", "format": "int32" }, "sandbox_project_name": { "type": "string", "description": "The name of the sandbox project" }, "tags": { "uniqueItems": true, "type": "array", "description": "The set of tags for the sandbox", "items": { "type": "string", "description": "The set of tags for the sandbox" } }, "referenced_sandbox_name": { "type": "string", "description": "The name of the referenced sandbox" }, "days": { "type": "integer", "description": "The number of days for sandbox retention", "format": "int32" }, "referenced_action_id": { "type": "integer", "description": "The ID of the referenced action", "format": "int32" }, "referenced_action_name": { "type": "string", "description": "The name of the referenced action" }, "sandbox_name": { "type": "string", "description": "The name of the sandbox" }, "snapshot_name": { "type": "string", "description": "The name of the snapshot" }, "snapshot_id": { "type": "string", "description": "The ID of the snapshot" }, "sandbox_distribution": { "type": "string", "description": "The distribution used for the sandbox" }, "resources": { "type": "string", "description": "The resource allocation for the sandbox", "enum": [ "1x2", "2x4", "3x6", "4x8", "5x10", "6x12", "7x14", "8x16", "9x18", "10x20", "11x22", "12x24", "CUSTOM" ] }, "return_existing": { "type": "boolean", "description": "If set to `true`, an existing sandbox will be returned" } }, "description": "This action type is deprecated. Please use alternative sandbox management actions.", "deprecated": true, "x-name": "Sandbox Application Stop" }, "SandboxCreateFromSandboxActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "sandbox_id": { "type": "string", "description": "The ID of the sandbox" }, "sandbox_references": { "uniqueItems": true, "type": "array", "description": "The set of sandbox reference types", "items": { "type": "string", "description": "The set of sandbox reference types", "enum": [ "BY_ID", "BY_TAGS", "BY_ACTION", "BY_NAME", "BY_PROJECT", "BY_DAYS" ] } }, "sandbox_project_id": { "type": "integer", "description": "The ID of the sandbox project", "format": "int32" }, "sandbox_project_name": { "type": "string", "description": "The name of the sandbox project" }, "tags": { "uniqueItems": true, "type": "array", "description": "The set of tags for the sandbox", "items": { "type": "string", "description": "The set of tags for the sandbox" } }, "referenced_sandbox_name": { "type": "string", "description": "The name of the referenced sandbox" }, "days": { "type": "integer", "description": "The number of days for sandbox retention", "format": "int32" }, "referenced_action_id": { "type": "integer", "description": "The ID of the referenced action", "format": "int32" }, "referenced_action_name": { "type": "string", "description": "The name of the referenced action" }, "sandbox_name": { "type": "string", "description": "The name of the sandbox" }, "snapshot_name": { "type": "string", "description": "The name of the snapshot" }, "snapshot_id": { "type": "string", "description": "The ID of the snapshot" }, "sandbox_distribution": { "type": "string", "description": "The distribution used for the sandbox" }, "resources": { "type": "string", "description": "The resource allocation for the sandbox", "enum": [ "1x2", "2x4", "3x6", "4x8", "5x10", "6x12", "7x14", "8x16", "9x18", "10x20", "11x22", "12x24", "CUSTOM" ] }, "return_existing": { "type": "boolean", "description": "If set to `true`, an existing sandbox will be returned" } }, "description": "This action type is deprecated. Please use alternative sandbox management actions.", "deprecated": true, "x-name": "Create Sandbox from Sandbox" }, "SandboxCreateFromSnapshotActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "sandbox_id": { "type": "string", "description": "The ID of the sandbox" }, "sandbox_references": { "uniqueItems": true, "type": "array", "description": "The set of sandbox reference types", "items": { "type": "string", "description": "The set of sandbox reference types", "enum": [ "BY_ID", "BY_TAGS", "BY_ACTION", "BY_NAME", "BY_PROJECT", "BY_DAYS" ] } }, "sandbox_project_id": { "type": "integer", "description": "The ID of the sandbox project", "format": "int32" }, "sandbox_project_name": { "type": "string", "description": "The name of the sandbox project" }, "tags": { "uniqueItems": true, "type": "array", "description": "The set of tags for the sandbox", "items": { "type": "string", "description": "The set of tags for the sandbox" } }, "referenced_sandbox_name": { "type": "string", "description": "The name of the referenced sandbox" }, "days": { "type": "integer", "description": "The number of days for sandbox retention", "format": "int32" }, "referenced_action_id": { "type": "integer", "description": "The ID of the referenced action", "format": "int32" }, "referenced_action_name": { "type": "string", "description": "The name of the referenced action" }, "sandbox_name": { "type": "string", "description": "The name of the sandbox" }, "snapshot_name": { "type": "string", "description": "The name of the snapshot" }, "snapshot_id": { "type": "string", "description": "The ID of the snapshot" }, "sandbox_distribution": { "type": "string", "description": "The distribution used for the sandbox" }, "resources": { "type": "string", "description": "The resource allocation for the sandbox", "enum": [ "1x2", "2x4", "3x6", "4x8", "5x10", "6x12", "7x14", "8x16", "9x18", "10x20", "11x22", "12x24", "CUSTOM" ] }, "return_existing": { "type": "boolean", "description": "If set to `true`, an existing sandbox will be returned" } }, "description": "This action type is deprecated. Please use alternative sandbox management actions.", "deprecated": true, "x-name": "Create Sandbox from Snapshot" }, "SandboxCreateNewActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "sandbox_id": { "type": "string", "description": "The ID of the sandbox" }, "sandbox_references": { "uniqueItems": true, "type": "array", "description": "The set of sandbox reference types", "items": { "type": "string", "description": "The set of sandbox reference types", "enum": [ "BY_ID", "BY_TAGS", "BY_ACTION", "BY_NAME", "BY_PROJECT", "BY_DAYS" ] } }, "sandbox_project_id": { "type": "integer", "description": "The ID of the sandbox project", "format": "int32" }, "sandbox_project_name": { "type": "string", "description": "The name of the sandbox project" }, "tags": { "uniqueItems": true, "type": "array", "description": "The set of tags for the sandbox", "items": { "type": "string", "description": "The set of tags for the sandbox" } }, "referenced_sandbox_name": { "type": "string", "description": "The name of the referenced sandbox" }, "days": { "type": "integer", "description": "The number of days for sandbox retention", "format": "int32" }, "referenced_action_id": { "type": "integer", "description": "The ID of the referenced action", "format": "int32" }, "referenced_action_name": { "type": "string", "description": "The name of the referenced action" }, "sandbox_name": { "type": "string", "description": "The name of the sandbox" }, "snapshot_name": { "type": "string", "description": "The name of the snapshot" }, "snapshot_id": { "type": "string", "description": "The ID of the snapshot" }, "sandbox_distribution": { "type": "string", "description": "The distribution used for the sandbox" }, "resources": { "type": "string", "description": "The resource allocation for the sandbox", "enum": [ "1x2", "2x4", "3x6", "4x8", "5x10", "6x12", "7x14", "8x16", "9x18", "10x20", "11x22", "12x24", "CUSTOM" ] }, "return_existing": { "type": "boolean", "description": "If set to `true`, an existing sandbox will be returned" } }, "description": "This action type is deprecated. Please use alternative sandbox management actions.", "deprecated": true, "x-name": "Create new sandbox" }, "SandboxDeleteActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "sandbox_id": { "type": "string", "description": "The ID of the sandbox" }, "sandbox_references": { "uniqueItems": true, "type": "array", "description": "The set of sandbox reference types", "items": { "type": "string", "description": "The set of sandbox reference types", "enum": [ "BY_ID", "BY_TAGS", "BY_ACTION", "BY_NAME", "BY_PROJECT", "BY_DAYS" ] } }, "sandbox_project_id": { "type": "integer", "description": "The ID of the sandbox project", "format": "int32" }, "sandbox_project_name": { "type": "string", "description": "The name of the sandbox project" }, "tags": { "uniqueItems": true, "type": "array", "description": "The set of tags for the sandbox", "items": { "type": "string", "description": "The set of tags for the sandbox" } }, "referenced_sandbox_name": { "type": "string", "description": "The name of the referenced sandbox" }, "days": { "type": "integer", "description": "The number of days for sandbox retention", "format": "int32" }, "referenced_action_id": { "type": "integer", "description": "The ID of the referenced action", "format": "int32" }, "referenced_action_name": { "type": "string", "description": "The name of the referenced action" }, "sandbox_name": { "type": "string", "description": "The name of the sandbox" }, "snapshot_name": { "type": "string", "description": "The name of the snapshot" }, "snapshot_id": { "type": "string", "description": "The ID of the snapshot" }, "sandbox_distribution": { "type": "string", "description": "The distribution used for the sandbox" }, "resources": { "type": "string", "description": "The resource allocation for the sandbox", "enum": [ "1x2", "2x4", "3x6", "4x8", "5x10", "6x12", "7x14", "8x16", "9x18", "10x20", "11x22", "12x24", "CUSTOM" ] }, "return_existing": { "type": "boolean", "description": "If set to `true`, an existing sandbox will be returned" } }, "description": "This action type is deprecated. Please use alternative sandbox management actions.", "deprecated": true, "x-name": "Sandbox Delete" }, "SandboxExecActionRequest": { "required": [ "commands", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "sandbox_id": { "type": "string", "description": "The ID of the sandbox" }, "sandbox_references": { "uniqueItems": true, "type": "array", "description": "The set of sandbox reference types", "items": { "type": "string", "description": "The set of sandbox reference types", "enum": [ "BY_ID", "BY_TAGS", "BY_ACTION", "BY_NAME", "BY_PROJECT", "BY_DAYS" ] } }, "sandbox_project_id": { "type": "integer", "description": "The ID of the sandbox project", "format": "int32" }, "sandbox_project_name": { "type": "string", "description": "The name of the sandbox project" }, "tags": { "uniqueItems": true, "type": "array", "description": "The set of tags for the sandbox", "items": { "type": "string", "description": "The set of tags for the sandbox" } }, "referenced_sandbox_name": { "type": "string", "description": "The name of the referenced sandbox" }, "days": { "type": "integer", "description": "The number of days for sandbox retention", "format": "int32" }, "referenced_action_id": { "type": "integer", "description": "The ID of the referenced action", "format": "int32" }, "referenced_action_name": { "type": "string", "description": "The name of the referenced action" }, "working_directory": { "type": "string", "description": "The working directory for the command execution" }, "commands": { "type": "array", "description": "The commands to execute in the sandbox", "items": { "type": "string", "description": "The commands to execute in the sandbox" } }, "shell": { "type": "string", "description": "The shell to use for command execution" }, "execute_every_command": { "type": "boolean", "description": "Execute every command separately" }, "user": { "type": "string", "description": "The user to execute commands as" } }, "description": "This action type is deprecated. Please use alternative sandbox management actions.", "deprecated": true, "x-name": "Sandbox Execute" }, "SandboxFetchView": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of the fetch item: PROJECT_REPO, PUBLIC_REPO, or ARTIFACT", "enum": [ "PROJECT_REPO", "PUBLIC_REPO", "ARTIFACT" ] }, "repository": { "type": "string", "description": "The URL of the git repository (for PUBLIC_REPO type)" }, "ref": { "type": "string", "description": "The branch, tag, or commit to checkout. Defaults to the default branch" }, "path": { "type": "string", "description": "The target path where the item will be cloned/downloaded. Defaults to the app directory" }, "build_command": { "type": "string", "description": "The command to run after fetching" }, "artifact": { "type": "string", "description": "The artifact identifier in format pkg:version (for ARTIFACT type)" } } }, "SandboxSnapshotActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "sandbox_id": { "type": "string", "description": "The ID of the sandbox" }, "sandbox_references": { "uniqueItems": true, "type": "array", "description": "The set of sandbox reference types", "items": { "type": "string", "description": "The set of sandbox reference types", "enum": [ "BY_ID", "BY_TAGS", "BY_ACTION", "BY_NAME", "BY_PROJECT", "BY_DAYS" ] } }, "sandbox_project_id": { "type": "integer", "description": "The ID of the sandbox project", "format": "int32" }, "sandbox_project_name": { "type": "string", "description": "The name of the sandbox project" }, "tags": { "uniqueItems": true, "type": "array", "description": "The set of tags for the sandbox", "items": { "type": "string", "description": "The set of tags for the sandbox" } }, "referenced_sandbox_name": { "type": "string", "description": "The name of the referenced sandbox" }, "days": { "type": "integer", "description": "The number of days for sandbox retention", "format": "int32" }, "referenced_action_id": { "type": "integer", "description": "The ID of the referenced action", "format": "int32" }, "referenced_action_name": { "type": "string", "description": "The name of the referenced action" }, "sandbox_name": { "type": "string", "description": "The name of the sandbox" }, "snapshot_name": { "type": "string", "description": "The name of the snapshot" }, "snapshot_id": { "type": "string", "description": "The ID of the snapshot" }, "sandbox_distribution": { "type": "string", "description": "The distribution used for the sandbox" }, "resources": { "type": "string", "description": "The resource allocation for the sandbox", "enum": [ "1x2", "2x4", "3x6", "4x8", "5x10", "6x12", "7x14", "8x16", "9x18", "10x20", "11x22", "12x24", "CUSTOM" ] }, "return_existing": { "type": "boolean", "description": "If set to `true`, an existing sandbox will be returned" } }, "description": "This action type is deprecated. Please use alternative sandbox management actions.", "deprecated": true, "x-name": "Sandbox Snapshot" }, "SandboxStartActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "sandbox_id": { "type": "string", "description": "The ID of the sandbox" }, "sandbox_references": { "uniqueItems": true, "type": "array", "description": "The set of sandbox reference types", "items": { "type": "string", "description": "The set of sandbox reference types", "enum": [ "BY_ID", "BY_TAGS", "BY_ACTION", "BY_NAME", "BY_PROJECT", "BY_DAYS" ] } }, "sandbox_project_id": { "type": "integer", "description": "The ID of the sandbox project", "format": "int32" }, "sandbox_project_name": { "type": "string", "description": "The name of the sandbox project" }, "tags": { "uniqueItems": true, "type": "array", "description": "The set of tags for the sandbox", "items": { "type": "string", "description": "The set of tags for the sandbox" } }, "referenced_sandbox_name": { "type": "string", "description": "The name of the referenced sandbox" }, "days": { "type": "integer", "description": "The number of days for sandbox retention", "format": "int32" }, "referenced_action_id": { "type": "integer", "description": "The ID of the referenced action", "format": "int32" }, "referenced_action_name": { "type": "string", "description": "The name of the referenced action" }, "sandbox_name": { "type": "string", "description": "The name of the sandbox" }, "snapshot_name": { "type": "string", "description": "The name of the snapshot" }, "snapshot_id": { "type": "string", "description": "The ID of the snapshot" }, "sandbox_distribution": { "type": "string", "description": "The distribution used for the sandbox" }, "resources": { "type": "string", "description": "The resource allocation for the sandbox", "enum": [ "1x2", "2x4", "3x6", "4x8", "5x10", "6x12", "7x14", "8x16", "9x18", "10x20", "11x22", "12x24", "CUSTOM" ] }, "return_existing": { "type": "boolean", "description": "If set to `true`, an existing sandbox will be returned" } }, "description": "This action type is deprecated. Please use alternative sandbox management actions.", "deprecated": true, "x-name": "Sandbox Start" }, "SandboxStopActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "sandbox_id": { "type": "string", "description": "The ID of the sandbox" }, "sandbox_references": { "uniqueItems": true, "type": "array", "description": "The set of sandbox reference types", "items": { "type": "string", "description": "The set of sandbox reference types", "enum": [ "BY_ID", "BY_TAGS", "BY_ACTION", "BY_NAME", "BY_PROJECT", "BY_DAYS" ] } }, "sandbox_project_id": { "type": "integer", "description": "The ID of the sandbox project", "format": "int32" }, "sandbox_project_name": { "type": "string", "description": "The name of the sandbox project" }, "tags": { "uniqueItems": true, "type": "array", "description": "The set of tags for the sandbox", "items": { "type": "string", "description": "The set of tags for the sandbox" } }, "referenced_sandbox_name": { "type": "string", "description": "The name of the referenced sandbox" }, "days": { "type": "integer", "description": "The number of days for sandbox retention", "format": "int32" }, "referenced_action_id": { "type": "integer", "description": "The ID of the referenced action", "format": "int32" }, "referenced_action_name": { "type": "string", "description": "The name of the referenced action" }, "sandbox_name": { "type": "string", "description": "The name of the sandbox" }, "snapshot_name": { "type": "string", "description": "The name of the snapshot" }, "snapshot_id": { "type": "string", "description": "The ID of the snapshot" }, "sandbox_distribution": { "type": "string", "description": "The distribution used for the sandbox" }, "resources": { "type": "string", "description": "The resource allocation for the sandbox", "enum": [ "1x2", "2x4", "3x6", "4x8", "5x10", "6x12", "7x14", "8x16", "9x18", "10x20", "11x22", "12x24", "CUSTOM" ] }, "return_existing": { "type": "boolean", "description": "If set to `true`, an existing sandbox will be returned" } }, "description": "This action type is deprecated. Please use alternative sandbox management actions.", "deprecated": true, "x-name": "Sandbox Stop" }, "SandboxView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "string", "description": "The ID of the sandbox" }, "identifier": { "type": "string", "description": "A human-readable ID. Alphanumeric characters, underscores, and hyphens (hyphens cannot appear at the start or end)." }, "name": { "type": "string", "description": "The name of the sandbox" }, "status": { "type": "string", "description": "The current status of the sandbox", "enum": [ "STARTING", "STOPPING", "FAILED", "RUNNING", "STOPPED", "RESTORING" ] }, "setup_status": { "type": "string", "description": "The current setup status of the sandbox", "enum": [ "INPROGRESS", "SUCCESS", "FAILED", "STALE" ] }, "os": { "type": "string", "description": "The operating system of the sandbox [\"ubuntu:22.04\", \"ubuntu:24.04\"]" }, "resources": { "type": "string", "description": "The resource configuration of the sandbox (CPU x RAM)", "enum": [ "1x2", "2x4", "3x6", "4x8", "5x10", "6x12", "7x14", "8x16", "9x18", "10x20", "11x22", "12x24", "CUSTOM" ] }, "first_boot_commands": { "type": "string", "description": "The commands to run during first boot of the sandbox" }, "app_dir": { "type": "string", "description": "The application directory of the sandbox" }, "apps": { "type": "array", "description": "The list of apps (run commands) for the sandbox", "items": { "$ref": "#/components/schemas/SandboxAppView" } }, "fetch": { "type": "array", "description": "The list of items (repositories and artifacts) to fetch into the sandbox", "items": { "$ref": "#/components/schemas/SandboxFetchView" } }, "timeout": { "type": "integer", "description": "The timeout in seconds after which the sandbox will be automatically stopped", "format": "int32" }, "tags": { "type": "array", "description": "The list of tags associated with the sandbox", "items": { "type": "string" } }, "boot_logs": { "type": "array", "description": "The boot logs of the sandbox", "items": { "type": "string" } }, "endpoints": { "type": "array", "description": "The tunnel endpoints of the sandbox", "items": { "$ref": "#/components/schemas/TunnelView" } }, "ssh_host": { "type": "string", "description": "The SSH hostname" }, "ssh_port": { "type": "integer", "description": "The SSH port", "format": "int32" }, "project": { "$ref": "#/components/schemas/ProjectView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" } }, "description": "The sandbox specification containing configuration details" }, "ScreenshotView": { "type": "object", "properties": { "url": { "type": "string", "description": "The URL of the page to capture" }, "baseline": { "type": "string", "description": "The name of the baseline image for comparison" }, "full_page": { "type": "boolean", "description": "If set to `true`, captures the full page instead of just the viewport" }, "wait_seconds": { "type": "integer", "description": "The number of seconds to wait before capturing the screenshot", "format": "int32" }, "wait_for_xpath": { "type": "string", "description": "The XPath of the element to wait for before capturing" }, "headers": { "type": "array", "description": "The list of HTTP headers to include in the request", "items": { "$ref": "#/components/schemas/HeaderView" } }, "excluded_areas": { "type": "array", "description": "The list of areas to exclude from visual comparison", "items": { "$ref": "#/components/schemas/ExcludedAreaView" } } }, "description": "The list of screenshots to capture and compare" }, "SentryActionRequest": { "required": [ "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "projects": { "type": "array", "description": "The list of Sentry project slugs", "items": { "type": "string", "description": "The list of Sentry project slugs" } }, "version": { "type": "string", "description": "The version of the release" }, "environment": { "type": "string", "description": "The environment for the release" }, "release_url": { "type": "string", "description": "The URL for the release" }, "deploy_url": { "type": "string", "description": "The URL for the deployment" }, "organization_slug": { "type": "string", "description": "The Sentry organization slug" }, "repository": { "type": "string", "description": "The repository name" }, "integration": { "$ref": "#/components/schemas/SentryIntegrationRef" } }, "x-name": "Sentry notification" }, "SentryEnterpriseActionRequest": { "required": [ "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "projects": { "type": "array", "description": "The list of Sentry project slugs", "items": { "type": "string", "description": "The list of Sentry project slugs" } }, "version": { "type": "string", "description": "The version of the release" }, "environment": { "type": "string", "description": "The environment for the release" }, "release_url": { "type": "string", "description": "The URL for the release" }, "deploy_url": { "type": "string", "description": "The URL for the deployment" }, "organization_slug": { "type": "string", "description": "The Sentry organization slug" }, "repository": { "type": "string", "description": "The repository name" }, "integration": { "$ref": "#/components/schemas/SentryEnterpriseIntegrationRef" } }, "x-name": "Sentry Self-Hosted" }, "SentryEnterpriseIntegrationRef": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" } }, "description": "Sentry Enterprise integration (SENTRY_ENTERPRISE)" }, "SentryIntegrationRef": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" } }, "description": "Sentry integration (SENTRY)" }, "ServiceConnectionView": { "type": "object", "properties": { "host": { "type": "string", "description": "The hostname or IP address of the service" }, "port": { "type": "integer", "description": "The port number of the service", "format": "int32" }, "user": { "type": "string", "description": "The username for service authentication" }, "password": { "type": "string", "description": "The password for service authentication" }, "db": { "type": "string", "description": "The database name to connect to" } }, "description": "The database connection details" }, "ServiceView": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of service (e.g., MYSQL, POSTGRES, MONGODB, REDIS, ELASTICSEARCH, MEMCACHED, CUSTOM)" }, "version": { "type": "string", "description": "The version of the service" }, "dump_path": { "type": "string", "description": "The path to the database dump file to import on service startup" }, "persistent": { "type": "boolean", "description": "If set to `true`, service data persists between pipeline executions" }, "connection": { "$ref": "#/components/schemas/ServiceConnectionView" }, "gas_price": { "type": "integer", "description": "The gas price for Ethereum blockchain services (in wei)", "format": "int64" }, "gas_limit": { "type": "integer", "description": "The gas limit for Ethereum blockchain services", "format": "int64" }, "accounts": { "type": "array", "description": "The list of Ethereum accounts for blockchain services", "items": { "type": "string", "description": "The list of Ethereum accounts for blockchain services" } }, "docker_image_name": { "type": "string", "description": "The name of the custom Docker image" }, "docker_image_tag": { "type": "string", "description": "The tag of the custom Docker image" }, "registry": { "type": "string", "description": "The Docker registry URL for custom images" }, "login": { "type": "string", "description": "The username for Docker registry authentication" }, "password": { "type": "string", "description": "The password for Docker registry authentication" }, "image_location": { "type": "string", "description": "The location of the Docker image (DOCKER_HUB, ECR, GCR, ACR, CUSTOM, etc.)", "enum": [ "PUBLIC_REGISTRY", "PRIVATE_REGISTRY", "ACTION", "ARTIFACT_REGISTRY" ] }, "docker_registry": { "type": "string", "description": "The type of Docker registry", "enum": [ "NONE", "DOCKER_HUB", "AMAZON_ECR", "GOOGLE_GCR", "GOOGLE_ARTIFACT_REGISTRY", "OTHER", "GIT_HUB_CONTAINER_REGISTRY", "ARTIFACT_REGISTRY", "DIGITAL_OCEAN_CONTAINER_REGISTRY" ] }, "use_image_from_action": { "type": "boolean", "description": "If set to `true`, uses the image built in a previous action" }, "docker_build_action_id": { "type": "integer", "description": "The numerical ID of the Docker build action to use", "format": "int32" }, "docker_build_action_name": { "type": "string", "description": "The name of the Docker build action to use" }, "working_directory": { "type": "string", "description": "The working directory for the service container" }, "volume_mappings": { "type": "array", "description": "The list of volume mappings in the format `host_path:container_path`", "items": { "type": "string", "description": "The list of volume mappings in the format `host_path:container_path`" } }, "entrypoint": { "type": "string", "description": "The entrypoint command for the container" }, "inline_commands": { "type": "string", "description": "The commands to execute in the container on startup" }, "region": { "type": "string", "description": "The region for cloud-based Docker registries (e.g., AWS ECR)" }, "wait_for_port": { "type": "integer", "description": "The port number to wait for before marking the service as ready", "format": "int32" }, "integration": { "$ref": "#/components/schemas/IntegrationView" }, "cached_dirs": { "type": "array", "description": "The list of directories to cache between executions", "items": { "type": "string", "description": "The list of directories to cache between executions" } }, "pass_variables": { "type": "boolean", "description": "If set to `true`, pipeline variables are passed to the service as environment variables" }, "run_as_user": { "type": "string", "description": "The user to run the service container as" }, "ignore_image_pull_failures": { "type": "boolean", "description": "If set to `true`, uses cached image when image pull fails or times out" }, "cache_base_image": { "type": "boolean", "description": "If set to `true`, caches the Docker image instead of pulling it on each execution" } }, "description": "The list of services attached to the build environment" }, "SetVariablesActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "comment": { "type": "string", "description": "The comment for the wait action" }, "description": { "type": "string", "description": "The description of the wait action" }, "prevent_self_approval": { "type": "boolean", "description": "If set to `true`, the approver must be different from the person who triggered the run. Default: `false`." }, "permissions": { "$ref": "#/components/schemas/PermissionsView" } }, "x-name": "Set variables" }, "ShopifyActionRequest": { "required": [ "integration", "local_path", "name", "theme", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The current git revision" }, "local_path": { "type": "string", "description": "The path to the local files to deploy" }, "remote_path": { "type": "string", "description": "The path on the remote server where files will be deployed" }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "deployment_includes": { "type": "array", "description": "The list of files or directories to include in deployment", "items": { "type": "string", "description": "The list of files or directories to include in deployment" } }, "input_type": { "type": "string", "description": "The type of source input", "enum": [ "SCM_REPOSITORY", "BUILD_ARTIFACTS" ] }, "deletion_disabled": { "type": "boolean", "description": "If set to `true`, files on the remote server will not be deleted" }, "use_temporary_files": { "type": "boolean", "description": "If set to `true`, files will be uploaded to a temporary directory first" }, "content_encoding": { "type": "string", "description": "The content encoding for deployed files" }, "integration": { "$ref": "#/components/schemas/ShopifyIntegrationRef" }, "theme": { "type": "string", "description": "The name of the Shopify theme" } }, "x-name": "Shopify" }, "ShopifyCliActionRequest": { "required": [ "execute_commands", "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/ShopifyIntegrationRef" } }, "x-name": "Shopify CLI" }, "ShopifyIntegrationRef": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" } }, "description": "Shopify integration (SHOPIFY)" }, "ShopifyThemekitActionRequest": { "required": [ "execute_commands", "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/ShopifyIntegrationRef" }, "theme": { "type": "string", "description": "The name of the Shopify theme" } }, "x-name": "Theme Kit CLI" }, "SlackActionRequest": { "required": [ "channel", "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "integration": { "$ref": "#/components/schemas/SlackIntegrationRef" }, "channel": { "type": "string", "description": "The Slack channel name or ID" }, "content": { "type": "string", "description": "The message content to send" }, "attachments": { "type": "array", "description": "The list of attachment URLs", "items": { "type": "string", "description": "The list of attachment URLs" } }, "file_attachments": { "type": "array", "description": "The list of file attachment paths", "items": { "type": "string", "description": "The list of file attachment paths" } }, "blocks": { "type": "string", "description": "The Slack blocks JSON for rich formatting" } }, "x-name": "Slack notification" }, "SlackIntegrationRef": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" } }, "description": "Slack integration (SLACK)" }, "SleepActionRequest": { "required": [ "name", "sleep_in_sec", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "sleep_in_sec": { "type": "integer", "description": "The duration to sleep in seconds", "format": "int32" } }, "x-name": "Sleep" }, "SmsActionRequest": { "required": [ "name", "recipients", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "content": { "type": "string", "description": "The SMS message content" }, "recipients": { "type": "string", "description": "The phone numbers to send the SMS to" } }, "x-name": "Sms notification" }, "SnykActionRequest": { "required": [ "execute_commands", "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/SnykIntegrationRef" }, "version": { "type": "string", "description": "The version of Snyk CLI to use" } }, "x-name": "Snyk" }, "SnykIntegrationRef": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" } }, "description": "Snyk integration (SNYK)" }, "SplitTestsActionRequest": { "required": [ "groups_count", "name", "source_path", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "source_path": { "type": "string", "description": "The path to the test files" }, "groups_count": { "type": "integer", "description": "The number of groups to split tests into", "format": "int32" }, "files_order": { "type": "string", "description": "The order in which test files should be sorted", "enum": [ "alphabetically", "size" ] } }, "x-name": "Split Tests" }, "SshCommandActionRequest": { "required": [ "commands", "name", "targets", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "working_directory": { "type": "string", "description": "The working directory for command execution" }, "commands": { "type": "array", "description": "The commands to execute via SSH", "items": { "type": "string", "description": "The commands to execute via SSH" } }, "shell": { "type": "string", "description": "The shell to use for command execution" }, "execute_every_command": { "type": "boolean", "description": "Execute every command separately" }, "run_as_script": { "type": "boolean", "description": "Run commands as a script file" }, "targets": { "type": "array", "description": "The list of target servers for SSH command execution", "items": { "$ref": "#/components/schemas/TargetView" } } }, "x-name": "SSH Command" }, "SslVerifyActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "website": { "type": "string", "description": "The website URL to verify SSL certificate for" }, "port": { "type": "string", "description": "The port to use for SSL verification" }, "valid_for_days": { "type": "integer", "description": "The minimum number of days the certificate should be valid for", "format": "int32" } }, "x-name": "SSL verify" }, "StackHawkActionRequest": { "required": [ "execute_commands", "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/StackHawkIntegrationRef" } }, "x-name": "StackHawk CLI" }, "StackHawkIntegrationRef": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" } }, "description": "StackHawk integration (STACK_HAWK)" }, "StorybookActionRequest": { "required": [ "docker_image_name", "docker_image_tag", "execute_commands", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "working_directory": { "type": "string", "description": "The directory in which the pipeline filesystem will be mounted" }, "main_service_name": { "type": "string", "description": "The hostname of the container in which the action is run. The container will be available under this name in the docker network for services" }, "run_as_user": { "type": "string", "description": "All build commands are run as the default user defined in the selected Docker image. Can be set to another username (on the condition that this user exists in the selected image)" }, "version": { "type": "string", "description": "The version of the artifact from artifact registry" }, "docker_image_name": { "type": "string", "description": "The name of the Docker image" }, "docker_image_tag": { "type": "string", "description": "The tag of the Docker image" }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "mount_filesystem_disable": { "type": "boolean", "description": "If set to `true`, the filesystem will not be mounted in the container" }, "volume_mappings": { "type": "array", "description": "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)", "items": { "type": "string", "description": "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)" } }, "cached_dirs": { "type": "array", "description": "The dependencies & directories to be cached and available to every execution in this pipeline", "items": { "type": "string", "description": "The dependencies & directories to be cached and available to every execution in this pipeline" } }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "services": { "type": "array", "description": "The list of services attached to the build environment", "items": { "$ref": "#/components/schemas/ServiceView" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "registry": { "type": "string", "description": "The URL of the Docker registry" }, "insecure_registry": { "type": "boolean", "description": "If set to `true`, the registry will be accessed over HTTP instead of HTTPS" }, "login": { "type": "string", "description": "The username for the Docker registry" }, "target_stage": { "type": "string", "description": "The target stage of the Dockerfile" }, "password": { "type": "string", "description": "The password for the Docker registry" }, "region": { "type": "string", "description": "The region for the Docker registry (for AWS ECR)" }, "image_location": { "type": "string", "description": "The location of the image used by the action", "enum": [ "PUBLIC_REGISTRY", "PRIVATE_REGISTRY", "ACTION", "ARTIFACT_REGISTRY" ] }, "use_image_from_action": { "type": "boolean", "description": "If set to `true`, the image from another action will be used" }, "docker_registry": { "type": "string", "description": "The type of registry from which the image is retrieved", "enum": [ "NONE", "DOCKER_HUB", "AMAZON_ECR", "GOOGLE_GCR", "GOOGLE_ARTIFACT_REGISTRY", "OTHER", "GIT_HUB_CONTAINER_REGISTRY", "ARTIFACT_REGISTRY", "DIGITAL_OCEAN_CONTAINER_REGISTRY" ] }, "docker_build_action_id": { "type": "integer", "description": "The ID of the action from which the Docker image will be used", "format": "int32" }, "docker_build_action_name": { "type": "string", "description": "The name of the action from which the Docker image will be used" }, "export_container_path": { "type": "string", "description": "The path in the container to export" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "ignore_image_pull_failures": { "type": "boolean", "description": "If set to `true`, use cached image on timeouts (only for official images)" }, "reset_entrypoint": { "type": "boolean", "description": "If set to `true`, resets the default entrypoint set by the image. Default value: `false`" }, "username": { "type": "string", "description": "The username for authentication" }, "cache_base_image": { "type": "boolean", "description": "If set to `true`, the cached version of the image is used, instead of being pulled each time" }, "do_not_prune_images": { "type": "boolean", "description": "If set to `true`, images will not be pruned after the build" }, "vt_suite": { "type": "string", "description": "The visual tests suite identifier" }, "unit_tests_suite": { "type": "string", "description": "The unit tests suite identifier" }, "unit_tests_path": { "type": "string", "description": "The path to the unit tests results" }, "integration": { "$ref": "#/components/schemas/DockerIntegrationRef" }, "artifact": { "type": "string", "description": "The identifier of the artifact from artifact registry" } }, "x-name": "Storybook" }, "SyncPathView": { "type": "object", "properties": { "pipeline_path": { "type": "string", "description": "The path in the pipeline filesystem to synchronize" }, "vm_path": { "type": "string", "description": "The path in the VM filesystem to synchronize" }, "direction": { "type": "string", "description": "The direction of synchronization", "enum": [ "PIPELINE_TO_VM", "VM_TO_PIPELINE" ] }, "excludes": { "type": "string", "description": "The list of file patterns to exclude from synchronization" }, "includes": { "type": "string", "description": "The list of file patterns to include in synchronization" } }, "description": "Define file paths that should be copied before (`PIPELINE_TO_VM`) and after the execution (`VM_TO_PIPELINE`)." }, "TcpActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "destination": { "type": "string", "description": "The destination address for the network action" }, "port": { "type": "string", "description": "The TCP port number to connect to" }, "text": { "type": "string", "description": "The text to search for in the response" }, "post_data": { "type": "string", "description": "The data to send to the TCP server" } }, "x-name": "TCP monitoring" }, "TelegramActionRequest": { "required": [ "integration", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "integration": { "$ref": "#/components/schemas/TelegramIntegrationRef" }, "content": { "type": "string", "description": "The message content to send" }, "parse_mode": { "type": "string", "description": "The parsing mode for the message", "enum": [ "PLAIN_TEXT", "MARKDOWN", "HTML" ] }, "file_attachments": { "type": "array", "description": "The list of file attachment paths", "items": { "type": "string", "description": "The list of file attachment paths" } } }, "x-name": "Telegram notification" }, "TelegramIntegrationRef": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" } }, "description": "Telegram integration (TELEGRAM)" }, "TerraformActionRequest": { "required": [ "execute_commands", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/TerraformIntegrationRef" }, "region": { "type": "string", "description": "The cloud provider region for Terraform resources" }, "server_key": { "type": "string", "description": "The server key for Terraform backend" }, "version": { "type": "string", "description": "The version of Terraform to use" }, "backend": { "type": "string", "description": "The Terraform backend configuration", "enum": [ "CUSTOM", "AMAZON", "GOOGLE" ] } }, "x-name": "Terraform CLI" }, "TerraformIntegrationRef": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" } }, "description": "Terraform integration (GOOGLE_SERVICE_ACCOUNT|AMAZON)" }, "TlsSettingsView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "private_key": { "type": "string", "description": "Private key for TLS certificate", "writeOnly": true }, "certificate": { "type": "string", "description": "TLS certificate", "writeOnly": true }, "ca_certificate": { "type": "string", "description": "Certificate Authority certificate", "writeOnly": true }, "terminate_at": { "type": "string", "description": "Where to terminate TLS connection", "enum": [ "REGION", "AGENT", "TARGET" ] } }, "description": "The TLS/SSL encryption settings of the tunnel" }, "TransferActionRequest": { "required": [ "local_path", "name", "targets", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The current git revision" }, "local_path": { "type": "string", "description": "The path to the local files to deploy" }, "remote_path": { "type": "string", "description": "The path on the remote server where files will be deployed" }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "deployment_includes": { "type": "array", "description": "The list of files or directories to include in deployment", "items": { "type": "string", "description": "The list of files or directories to include in deployment" } }, "input_type": { "type": "string", "description": "The type of source input", "enum": [ "SCM_REPOSITORY", "BUILD_ARTIFACTS" ] }, "deletion_disabled": { "type": "boolean", "description": "If set to `true`, files on the remote server will not be deleted" }, "use_temporary_files": { "type": "boolean", "description": "If set to `true`, files will be uploaded to a temporary directory first" }, "content_encoding": { "type": "string", "description": "The content encoding for deployed files" }, "targets": { "type": "array", "description": "The list of target servers for file transfer", "items": { "$ref": "#/components/schemas/TargetView" } }, "compress": { "type": "boolean", "description": "Enable file compression during ssh transfer" } }, "x-name": "Transfer" }, "TriggerConditionOperandView": { "type": "object", "properties": { "trigger_condition": { "type": "string", "description": "The type of trigger condition", "enum": [ "ALWAYS", "ON_CHANGE", "ON_CHANGE_AT_PATH", "VAR_IS", "VAR_IS_NOT", "VAR_CONTAINS", "VAR_NOT_CONTAINS", "DATETIME", "SUCCESS_PIPELINE", "DAY", "HOUR", "OR", "VAR_LESS_THAN", "VAR_LESS_THAN_OR_EQUAL", "VAR_GREATER_THAN", "VAR_GREATER_THAN_OR_EQUAL", "ACTION_STATUS_IS", "ACTION_STATUS_IS_NOT", "TRIGGERING_USER_IS", "TRIGGERING_USER_IS_NOT", "TRIGGERING_USER_IS_IN_GROUP", "TRIGGERING_USER_IS_NOT_IN_GROUP" ] }, "trigger_variable_value": { "type": "string", "description": "The value to compare the trigger variable against" }, "trigger_variable_key": { "type": "string", "description": "The name of the variable to check in the trigger condition" }, "timezone": { "type": "string", "description": "The timezone for datetime trigger conditions (e.g., 'UTC', 'Europe/Warsaw')" }, "trigger_hours": { "type": "array", "description": "The hours when the datetime trigger should activate (0-23)", "items": { "type": "integer", "format": "int32" } }, "trigger_days": { "type": "array", "description": "The days when the datetime trigger should activate (1-7, where 1 is Monday)", "items": { "type": "integer", "format": "int32" } }, "trigger_project_name": { "type": "string", "description": "The project name for cross-project pipeline triggers" }, "trigger_pipeline_name": { "type": "string", "description": "The pipeline name for cross-pipeline triggers" }, "trigger_user": { "type": "string", "description": "The email of the user who can trigger the pipeline" }, "trigger_group": { "type": "string", "description": "The name of the group that can trigger the pipeline" }, "trigger_condition_paths": { "type": "array", "description": "The file paths that must change to trigger the pipeline", "items": { "type": "string" } }, "trigger_status": { "type": "string", "description": "The action status to check for action status triggers", "enum": [ "SUCCESSFUL", "FAILED", "SKIPPED", "SUPPRESSED" ] }, "trigger_action_name": { "type": "string", "description": "The name of the action to check status for" } } }, "TriggerConditionView": { "type": "object", "properties": { "trigger_condition": { "type": "string", "description": "The type of trigger condition", "enum": [ "ALWAYS", "ON_CHANGE", "ON_CHANGE_AT_PATH", "VAR_IS", "VAR_IS_NOT", "VAR_CONTAINS", "VAR_NOT_CONTAINS", "DATETIME", "SUCCESS_PIPELINE", "DAY", "HOUR", "OR", "VAR_LESS_THAN", "VAR_LESS_THAN_OR_EQUAL", "VAR_GREATER_THAN", "VAR_GREATER_THAN_OR_EQUAL", "ACTION_STATUS_IS", "ACTION_STATUS_IS_NOT", "TRIGGERING_USER_IS", "TRIGGERING_USER_IS_NOT", "TRIGGERING_USER_IS_IN_GROUP", "TRIGGERING_USER_IS_NOT_IN_GROUP" ] }, "trigger_variable_value": { "type": "string", "description": "The value to compare the trigger variable against" }, "trigger_variable_key": { "type": "string", "description": "The name of the variable to check in the trigger condition" }, "timezone": { "type": "string", "description": "The timezone for datetime trigger conditions (e.g., 'UTC', 'Europe/Warsaw')" }, "trigger_hours": { "type": "array", "description": "The hours when the datetime trigger should activate (0-23)", "items": { "type": "integer", "format": "int32" } }, "trigger_days": { "type": "array", "description": "The days when the datetime trigger should activate (1-7, where 1 is Monday)", "items": { "type": "integer", "format": "int32" } }, "trigger_project_name": { "type": "string", "description": "The project name for cross-project pipeline triggers" }, "trigger_pipeline_name": { "type": "string", "description": "The pipeline name for cross-pipeline triggers" }, "trigger_user": { "type": "string", "description": "The email of the user who can trigger the pipeline" }, "trigger_group": { "type": "string", "description": "The name of the group that can trigger the pipeline" }, "trigger_condition_paths": { "type": "array", "description": "The file paths that must change to trigger the pipeline", "items": { "type": "string" } }, "trigger_status": { "type": "string", "description": "The action status to check for action status triggers", "enum": [ "SUCCESSFUL", "FAILED", "SKIPPED", "SUPPRESSED" ] }, "trigger_action_name": { "type": "string", "description": "The name of the action to check status for" }, "trigger_operands": { "type": "array", "description": "The list of nested trigger conditions for OR/AND operators", "items": { "$ref": "#/components/schemas/TriggerConditionOperandView" } } }, "description": "The list of trigger conditions to meet so that the action can be triggered" }, "TrivyCliActionRequest": { "required": [ "execute_commands", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "version": { "type": "string", "description": "The version of the Trivy image to use. Default: `latest`" } }, "x-name": "Trivy CLI" }, "TunnelView": { "required": [ "endpoint", "name", "region", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "name": { "type": "string", "description": "The name of the tunnel" }, "endpoint": { "type": "string", "description": "The endpoint URL of the tunnel" }, "type": { "type": "string", "description": "The type of the tunnel", "enum": [ "TCP", "TLS", "HTTP", "SSH" ] }, "region": { "type": "string", "description": "The region where the tunnel is deployed", "enum": [ "US", "EU", "AS" ] }, "whitelist": { "type": "array", "description": "The IP addresses or domains allowed to access the tunnel", "items": { "type": "string" } }, "timeout": { "type": "integer", "description": "The connection timeout of the tunnel in seconds", "format": "int32" }, "http": { "$ref": "#/components/schemas/HttpSettingsView" }, "tls": { "$ref": "#/components/schemas/TlsSettingsView" }, "endpoint_url": { "type": "string", "description": "The url of the tunnel" } } }, "VisualTest2ActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "vt_suite": { "type": "string", "description": "The visual test suite identifier" }, "urls": { "type": "array", "description": "URLs to compare (comma separated list, e.g., `https://example.com,https://example.org`)", "items": { "type": "string", "description": "URLs to compare (comma separated list, e.g., `https://example.com,https://example.org`)" } }, "sitemap": { "type": "string", "description": "URL from which sitemap will be gathered" }, "urls_file": { "type": "string", "description": "File with URLs to compare" }, "ignore_urls": { "type": "array", "description": "Ignore URLs matching the regex pattern", "items": { "type": "string", "description": "Ignore URLs matching the regex pattern" } }, "follow": { "type": "boolean", "description": "Scrap all subviews of the page. Default: false" }, "respect_robots": { "type": "boolean", "description": "Respect robots.txt. Default: false" }, "ignores": { "type": "array", "description": "Ignore elements matching selectors while comparing (format: [scope::]type=value, e.g., \"CSS=.ad-banner\" or \"XPATH=//div[@id='popup']\" or \"example.com::CSS=.cookie-notice\")", "items": { "type": "string", "description": "Ignore elements matching selectors while comparing (format: [scope::]type=value, e.g., \"CSS=.ad-banner\" or \"XPATH=//div[@id='popup']\" or \"example.com::CSS=.cookie-notice\")" } }, "delays": { "type": "array", "description": "Add delay in milliseconds before taking screenshot (format: [scope::]milliseconds, e.g., \"1000\" or \"example.com::2000\")", "items": { "type": "string", "description": "Add delay in milliseconds before taking screenshot (format: [scope::]milliseconds, e.g., \"1000\" or \"example.com::2000\")" } }, "wait_for": { "type": "array", "description": "Wait for elements to appear before taking screenshot (format: [scope::]type=value, e.g., \"CSS=#content\" or \"example.com::XPATH=//div[@class='loaded']\")", "items": { "type": "string", "description": "Wait for elements to appear before taking screenshot (format: [scope::]type=value, e.g., \"CSS=#content\" or \"example.com::XPATH=//div[@class='loaded']\")" } }, "cookies": { "type": "array", "description": "Set cookies used when visiting the URLs (format: [scope::]cookie_value, e.g., \"session=abc123\" or \"example.com::auth=token123; Path=/; Secure; HttpOnly\")", "items": { "type": "string", "description": "Set cookies used when visiting the URLs (format: [scope::]cookie_value, e.g., \"session=abc123\" or \"example.com::auth=token123; Path=/; Secure; HttpOnly\")" } }, "headers": { "type": "array", "description": "Set HTTP headers used when visiting the URLs (format: [scope::]name=value, e.g., \"Authorization=Bearer token\" or \"example.com::Accept=application/json\")", "items": { "type": "string", "description": "Set HTTP headers used when visiting the URLs (format: [scope::]name=value, e.g., \"Authorization=Bearer token\" or \"example.com::Accept=application/json\")" } } }, "x-name": "Visual tests" }, "VisualTestsActionRequest": { "required": [ "images_history_limit", "name", "pixel_tolerance_level", "resolution_height", "resolution_width", "screenshots", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "resolution_width": { "type": "integer", "description": "The width of the browser viewport in pixels", "format": "int32" }, "resolution_height": { "type": "integer", "description": "The height of the browser viewport in pixels", "format": "int32" }, "pixel_tolerance_level": { "type": "number", "description": "The tolerance level for pixel differences (0.0 to 1.0)", "format": "double" }, "images_history_limit": { "type": "integer", "description": "The maximum number of historical images to keep", "format": "int32" }, "headers": { "type": "array", "description": "The HTTP headers to include in requests", "items": { "$ref": "#/components/schemas/HeaderView" } }, "screenshots": { "type": "array", "description": "The list of screenshots to capture and compare", "items": { "$ref": "#/components/schemas/ScreenshotView" } }, "permissions": { "$ref": "#/components/schemas/PermissionsView" } }, "deprecated": true, "x-name": "Visual Tests (Old)" }, "WaitForApplyActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "comment": { "type": "string", "description": "The comment for the wait action" }, "description": { "type": "string", "description": "The description of the wait action" }, "prevent_self_approval": { "type": "boolean", "description": "If set to `true`, the approver must be different from the person who triggered the run. Default: `false`." }, "permissions": { "$ref": "#/components/schemas/PermissionsView" } }, "x-name": "Wait for apply" }, "WaitForVariablesActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "comment": { "type": "string", "description": "The comment for the wait action" }, "description": { "type": "string", "description": "The description of the wait action" }, "prevent_self_approval": { "type": "boolean", "description": "If set to `true`, the approver must be different from the person who triggered the run. Default: `false`." }, "permissions": { "$ref": "#/components/schemas/PermissionsView" } }, "x-name": "Wait for variables" }, "WebActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "destination": { "type": "string", "description": "The destination address for the network action" }, "port": { "type": "string", "description": "The port number for the HTTP request" }, "login": { "type": "string", "description": "The login username for HTTP authentication" }, "password": { "type": "string", "description": "The password for HTTP authentication" }, "headers": { "type": "array", "description": "The HTTP headers to include in the request", "items": { "$ref": "#/components/schemas/HeaderView" } }, "post_data": { "type": "string", "description": "The POST data to send with the request" }, "text": { "type": "string", "description": "The text to search for in the response" }, "text_existence": { "type": "boolean", "description": "If set to `true`, the action will succeed if the text is found; if `false`, it will succeed if the text is not found" } }, "x-name": "Web monitoring" }, "WebDavActionRequest": { "required": [ "local_path", "name", "type", "web_dav_url" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The current git revision" }, "local_path": { "type": "string", "description": "The path to the local files to deploy" }, "remote_path": { "type": "string", "description": "The path on the remote server where files will be deployed" }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "deployment_includes": { "type": "array", "description": "The list of files or directories to include in deployment", "items": { "type": "string", "description": "The list of files or directories to include in deployment" } }, "input_type": { "type": "string", "description": "The type of source input", "enum": [ "SCM_REPOSITORY", "BUILD_ARTIFACTS" ] }, "deletion_disabled": { "type": "boolean", "description": "If set to `true`, files on the remote server will not be deleted" }, "use_temporary_files": { "type": "boolean", "description": "If set to `true`, files will be uploaded to a temporary directory first" }, "content_encoding": { "type": "string", "description": "The content encoding for deployed files" }, "web_dav_url": { "type": "string", "description": "The WebDAV server URL" }, "login": { "type": "string", "description": "The login username for WebDAV authentication" }, "password": { "type": "string", "description": "The password for WebDAV authentication" } }, "x-name": "WebDAV" }, "WindowsNativeBuildActionRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "working_directory": { "type": "string", "description": "The directory in which the pipeline filesystem will be mounted" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "commands": { "type": "array", "description": "The commands to execute in the native build environment", "items": { "type": "string", "description": "The commands to execute in the native build environment" } }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "vm_from_prev_action": { "type": "boolean", "description": "If set to `true`, the VM from the previous action will be used" }, "vm_action_id": { "type": "integer", "description": "The ID of the action from which the VM will be used", "format": "int32" }, "vm_action_name": { "type": "string", "description": "The name of the action from which the VM will be used" }, "instance_type": { "type": "string", "description": "The type of instance to use for the native build", "enum": [ "GENERAL_MEDIUM", "GENERAL_LARGE", "GENERAL_XLARGE", "GENERAL_2XLARGE", "COMPUTE_MEDIUM", "COMPUTE_LARGE", "COMPUTE_XLARGE", "COMPUTE_2XLARGE", "ARM_GENERAL_MEDIUM", "ARM_GENERAL_LARGE", "ARM_GENERAL_XLARGE", "ARM_GENERAL_2XLARGE", "ARM_COMPUTE_MEDIUM", "ARM_COMPUTE_LARGE", "ARM_COMPUTE_XLARGE", "ARM_COMPUTE_2XLARGE" ] }, "sync_paths": { "type": "array", "description": "The list of paths to synchronize", "items": { "$ref": "#/components/schemas/SyncPathView" } }, "distribution": { "type": "string", "description": "The AWS distribution type", "enum": [ "UBUNTU_20_04", "AMI", "WINDOWS_SERVER_2019", "PREVIOUS_ACTION" ] }, "ami": { "$ref": "#/components/schemas/AmiView" } }, "x-name": "Windows" }, "WpCliActionRequest": { "required": [ "execute_commands", "name", "type", "version" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "config": { "type": "string", "description": "The WP-CLI configuration options" }, "env_key": { "type": "string", "description": "The environment key for WordPress configuration" }, "version": { "type": "string", "description": "The WP-CLI version to use" } }, "x-name": "WP CLI" }, "ZipActionRequest": { "required": [ "destination", "local_path", "name", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "after_action_id": { "type": "integer", "description": "The numerical ID of the action, after which this action should be added", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "local_path": { "type": "string", "description": "The local path to the files to compress" }, "destination": { "type": "string", "description": "The destination path for the ZIP archive" }, "deployment_excludes": { "type": "array", "description": "The list of file patterns to exclude from the ZIP archive", "items": { "type": "string", "description": "The list of file patterns to exclude from the ZIP archive" } }, "deployment_includes": { "type": "array", "description": "The list of file patterns to include in the ZIP archive", "items": { "type": "string", "description": "The list of file patterns to include in the ZIP archive" } } }, "x-name": "ZIP" }, "ActionResponse": { "type": "object", "discriminator": { "propertyName": "type", "mapping": { "BUILD": "#/components/schemas/BuildActionResponse", "EMAIL": "#/components/schemas/EmailActionResponse", "AMAZON_S3": "#/components/schemas/AmazonS3ActionResponse", "SSH_COMMAND": "#/components/schemas/SshCommandActionResponse", "HTTP": "#/components/schemas/HttpActionResponse", "VISUAL_TESTS": "#/components/schemas/VisualTestsActionResponse", "VISUAL_TEST_2": "#/components/schemas/VisualTest2ActionResponse", "SLACK": "#/components/schemas/SlackActionResponse", "TELEGRAM": "#/components/schemas/TelegramActionResponse", "DISCORD2": "#/components/schemas/DiscordActionResponse", "MICROSOFT_TEAMS": "#/components/schemas/MicrosoftTeamsActionResponse", "GOOGLE_CHAT": "#/components/schemas/GoogleChatActionResponse", "SMS": "#/components/schemas/SmsActionResponse", "PUSHOVER": "#/components/schemas/PushoverActionResponse", "PUSHBULLET": "#/components/schemas/PushbulletActionResponse", "HONEYBADGER": "#/components/schemas/HoneybadgerActionResponse", "NEW_RELIC": "#/components/schemas/NewRelicActionResponse", "ROLLBAR": "#/components/schemas/RollbarActionResponse", "SENTRY": "#/components/schemas/SentryActionResponse", "SENTRY_ENTERPRISE": "#/components/schemas/SentryActionResponse", "DATADOG": "#/components/schemas/DatadogActionResponse", "DATADOG_STATUS_CHECK": "#/components/schemas/DatadogStatusCheckActionResponse", "BUGSNAG": "#/components/schemas/BugsnagActionResponse", "RAYGUN": "#/components/schemas/RaygunActionResponse", "LOGGLY": "#/components/schemas/LogglyActionResponse", "GHOST_INSPECTOR": "#/components/schemas/GhostInspectorActionResponse", "ATOP": "#/components/schemas/AtopActionResponse", "JIRA_BUILD": "#/components/schemas/JiraBuildActionResponse", "JIRA_DEPLOYMENT": "#/components/schemas/JiraDeploymentActionResponse", "DO_SPACES": "#/components/schemas/DoSpacesActionResponse", "BACKBLAZE_B2": "#/components/schemas/BackblazeB2ActionResponse", "GCS": "#/components/schemas/GcsActionResponse", "GOOGLE_CLOUD_STORAGE": "#/components/schemas/GcsActionResponse", "RACKSPACE": "#/components/schemas/RackspaceActionResponse", "SHOPIFY": "#/components/schemas/ShopifyActionResponse", "WEB_DAV": "#/components/schemas/WebDavActionResponse", "TRANSFER": "#/components/schemas/TransferActionResponse", "AZURE_STORAGE": "#/components/schemas/AzureStorageActionResponse", "DEPLOY_TO_SANDBOX": "#/components/schemas/DeployToSandboxActionResponse", "PUBLISH_ARTIFACT_VERSION": "#/components/schemas/PublishArtifactVersionActionResponse", "POWERSHELL": "#/components/schemas/PowershellActionResponse", "SANDBOX_EXEC": "#/components/schemas/SandboxExecActionResponse", "PUSH": "#/components/schemas/PushActionResponse", "AZURE": "#/components/schemas/AzureActionResponse", "HEROKU": "#/components/schemas/HerokuActionResponse", "WEB": "#/components/schemas/WebActionResponse", "TCP": "#/components/schemas/TcpActionResponse", "PING": "#/components/schemas/PingActionResponse", "STORYBOOK": "#/components/schemas/StorybookActionResponse", "CUSTOM": "#/components/schemas/CustomActionResponse", "RUN_DOCKER_CONTAINER": "#/components/schemas/RunDockerContainerActionResponse", "DOCKERFILE": "#/components/schemas/DockerfileActionResponse", "DOCKER_BUILD_MULTI_ARCH": "#/components/schemas/DockerBuildMultiArchActionResponse", "DOCKER_PUSH": "#/components/schemas/DockerPushActionResponse", "GOOGLE_APP_ENGINE": "#/components/schemas/GoogleAppEngineActionResponse", "GOOGLE_APP_DEPLOY": "#/components/schemas/GoogleAppDeployActionResponse", "GCLOUD_CLI": "#/components/schemas/GoogleCloudCliActionResponse", "GOOGLE_CLOUD_CLI": "#/components/schemas/GoogleCloudCliActionResponse", "GCLOUD_RUN_DEPLOY": "#/components/schemas/GoogleCloudRunDeployActionResponse", "GOOGLE_CLOUD_RUN_DEPLOY": "#/components/schemas/GoogleCloudRunDeployActionResponse", "HEROKU_CLI": "#/components/schemas/HerokuCliActionResponse", "AWS_CLI": "#/components/schemas/AwsCliActionResponse", "AWS_CLI_2": "#/components/schemas/AwsCli2ActionResponse", "AWS_CLOUD_FORMATION": "#/components/schemas/AwsCloudFormationActionResponse", "AWS_LAMBDA_DEPLOY": "#/components/schemas/AwsLambdaDeployActionResponse", "GOOGLE_FUNCTIONS_DEPLOY": "#/components/schemas/GoogleFunctionDeployActionResponse", "GOOGLE_FUNCTION_DEPLOY": "#/components/schemas/GoogleFunctionDeployActionResponse", "RUN_NEXT_PIPELINE": "#/components/schemas/RunNextPipelineActionResponse", "COPY_FILES": "#/components/schemas/CopyFilesActionResponse", "WAIT_FOR_APPLY": "#/components/schemas/WaitForApplyActionResponse", "WAIT_FOR_VARIABLES": "#/components/schemas/WaitForVariablesActionResponse", "SET_VARIABLES": "#/components/schemas/SetVariablesActionResponse", "APPROVE_VT": "#/components/schemas/ApproveVtActionResponse", "ELASTIC_BEANSTALK": "#/components/schemas/AwsElasticBeanstalkActionResponse", "CODE_DEPLOY": "#/components/schemas/AwsCodeDeployActionResponse", "AWS_APP_RUNNER_DEPLOY": "#/components/schemas/AwsAppRunnerDeployActionResponse", "AWS_ECS": "#/components/schemas/AwsEcsActionResponse", "LAMBDA": "#/components/schemas/AwsLambdaInvokeActionResponse", "GOOGLE_FUNCTIONS": "#/components/schemas/GoogleFunctionInvokeActionResponse", "GOOGLE_FUNCTION_INVOKE": "#/components/schemas/GoogleFunctionInvokeActionResponse", "CLOUDFLARE": "#/components/schemas/CloudflareInvalidationActionResponse", "CLOUD_FRONT": "#/components/schemas/CloudFrontInvalidationActionResponse", "GOOGLE_CDN": "#/components/schemas/GoogleCdnInvalidationActionResponse", "GOOGLE_CDN_INVALIDATE": "#/components/schemas/GoogleCdnInvalidationActionResponse", "DIGITAL_OCEAN_CDN": "#/components/schemas/DigitalOceanCdnInvalidationActionResponse", "RSYNC": "#/components/schemas/RsyncActionResponse", "MONITOR": "#/components/schemas/AwsElasticBeanstalkMonitorActionResponse", "AWS_APP_RUNNER_MONITOR": "#/components/schemas/AwsAppRunnerMonitorActionResponse", "SLEEP": "#/components/schemas/SleepActionResponse", "KUBERNETES_APPLY": "#/components/schemas/KubernetesApplyActionResponse", "KUBERNETES_SET_IMAGE": "#/components/schemas/KubernetesSetImageActionResponse", "KUBERNETES_RUN_POD": "#/components/schemas/KubernetesRunPodActionResponse", "KUBERNETES_RUN_JOB": "#/components/schemas/KubernetesRunJobActionResponse", "KUBERNETES_CLI": "#/components/schemas/KubernetesCliActionResponse", "HELM": "#/components/schemas/HelmActionResponse", "ZIP": "#/components/schemas/ZipActionResponse", "ESLINT": "#/components/schemas/EslintActionResponse", "ANDROID_SIGN": "#/components/schemas/AndroidSignActionResponse", "ANDROID_SIGN_BUNDLE": "#/components/schemas/AndroidSignBundleActionResponse", "ANDROID_PLAY": "#/components/schemas/AndroidUploadApkActionResponse", "ANDROID_PLAY_BUNDLE": "#/components/schemas/AndroidUploadBundleActionResponse", "ANDROID_PUBLISH_APK": "#/components/schemas/AndroidPublishApkActionResponse", "ANDROID_PUBLISH_APP_BUNDLE": "#/components/schemas/AndroidPublishAppBundleActionResponse", "FIREBASE": "#/components/schemas/FirebaseActionResponse", "NETLIFY": "#/components/schemas/NetlifyActionResponse", "LIGHTHOUSE": "#/components/schemas/LighthouseActionResponse", "REPLACE": "#/components/schemas/ReplaceActionResponse", "GIT_CRYPT_UNLOCK": "#/components/schemas/GitCryptActionResponse", "GIT_CRYPT_LOCK": "#/components/schemas/GitCryptActionResponse", "SPLIT_TESTS": "#/components/schemas/SplitTestsActionResponse", "IMAGE_COMPRESSION": "#/components/schemas/ImageCompressionActionResponse", "DOCKERFILE_LINTER": "#/components/schemas/DockerfileLinterActionResponse", "DOWNLOAD": "#/components/schemas/DownloadFtpActionResponse", "DOWNLOAD_S3": "#/components/schemas/DownloadS3ActionResponse", "DOWNLOAD_FROM_SANDBOX": "#/components/schemas/DownloadFromSandboxActionResponse", "DOWNLOAD_GCS": "#/components/schemas/DownloadFromGcsActionResponse", "DOWNLOAD_BACKBLAZE_B2": "#/components/schemas/DownloadBackblazeActionResponse", "DOWNLOAD_ARTIFACT_VERSION": "#/components/schemas/DownloadArtifactActionResponse", "SANDBOX_START": "#/components/schemas/SandboxStartActionResponse", "SANDBOX_STOP": "#/components/schemas/SandboxStopActionResponse", "SANDBOX_SNAPSHOT": "#/components/schemas/SandboxSnapshotActionResponse", "SANDBOX_CREATE_NEW": "#/components/schemas/SandboxCreateNewActionResponse", "SANDBOX_CREATE_FROM_SANDBOX": "#/components/schemas/SandboxCreateFromSandboxActionResponse", "SANDBOX_CREATE_FROM_SNAPSHOT": "#/components/schemas/SandboxCreateFromSnapshotActionResponse", "SANDBOX_DELETE": "#/components/schemas/SandboxDeleteActionResponse", "SANDBOX_APPLICATION_START": "#/components/schemas/SandboxApplicationStartActionResponse", "SANDBOX_APPLICATION_STOP": "#/components/schemas/SandboxApplicationStopActionResponse", "SANDBOX_MANAGE": "#/components/schemas/ManageSandboxActionResponse", "SANDBOX_CREATE": "#/components/schemas/CreateSandboxActionResponse", "LINK_VALIDATOR": "#/components/schemas/LinkValidatorActionResponse", "LINK_CHECKER": "#/components/schemas/LinkCheckerActionResponse", "AZURE_CLI": "#/components/schemas/AzureCliActionResponse", "SHOPIFY_THEMEKIT_CLI": "#/components/schemas/ShopifyThemekitActionResponse", "SHOPIFY_CLI": "#/components/schemas/ShopifyCliActionResponse", "SSL_VERIFY": "#/components/schemas/SslVerifyActionResponse", "GIT_HUB_RELEASE": "#/components/schemas/GitHubReleaseActionResponse", "NATIVE_BUILD_WINDOWS": "#/components/schemas/WindowsNativeBuildActionResponse", "NATIVE_BUILD_MAC": "#/components/schemas/MacNativeBuildActionResponse", "NATIVE_BUILD_MAC_VM": "#/components/schemas/MacVmNativeBuildActionResponse", "NATIVE_BUILD_MAC_REACT": "#/components/schemas/MacReactNativeBuildActionResponse", "NATIVE_BUILD_MAC_CORDOVA": "#/components/schemas/MacCordovaNativeBuildActionResponse", "NATIVE_BUILD_MAC_FASTLANE": "#/components/schemas/MacFastlaneNativeBuildActionResponse", "NATIVE_BUILD_MAC_FLUTTER": "#/components/schemas/MacFlutterNativeBuildActionResponse", "NATIVE_BUILD_MAC_SIGN": "#/components/schemas/MacSignNativeBuildActionResponse", "NATIVE_BUILD_MAC_DEPLOY": "#/components/schemas/MacDeployNativeBuildActionResponse", "NATIVE_BUILD_DOCKER_CLI": "#/components/schemas/DockerCliNativeBuildActionResponse", "NATIVE_BUILD_LINUX": "#/components/schemas/LinuxNativeBuildActionResponse", "DOCTL": "#/components/schemas/DoctlActionResponse", "CLEAR_CACHE": "#/components/schemas/ClearCacheActionResponse", "FASTLANE_ANDROID": "#/components/schemas/FastlaneAndroidActionResponse", "GIT_HUB_CLI": "#/components/schemas/GitHubCliActionResponse", "GIT_LAB_CLI": "#/components/schemas/GitLabCliActionResponse", "INTEGRATION_VARIABLES": "#/components/schemas/IntegrationVariablesActionResponse", "CODE_PIPELINE": "#/components/schemas/CodePipelineActionResponse", "AWS_CDK_CLI": "#/components/schemas/AwsCdkCliActionResponse", "GHOST_INSPECTOR_CLI": "#/components/schemas/GhostInspectorCliActionResponse", "TERRAFORM": "#/components/schemas/TerraformActionResponse", "SNYK_CLI": "#/components/schemas/SnykActionResponse", "STACK_HAWK_CLI": "#/components/schemas/StackHawkActionResponse", "JMETER_CLI": "#/components/schemas/JmeterActionResponse", "TRIVY_CLI": "#/components/schemas/TrivyCliActionResponse", "BLACKFIRE_PHP": "#/components/schemas/BlackfirePhpActionResponse", "BLACKFIRE_PYTHON": "#/components/schemas/BlackfirePythonActionResponse", "BLACKFIRE_GO": "#/components/schemas/BlackfireGoActionResponse", "DOCKER": "#/components/schemas/DockerCliActionResponse", "PIPELINE_SETTINGS": "#/components/schemas/PipelineSettingsActionResponse", "NEW_RELIC_CLI": "#/components/schemas/NewRelicCliActionResponse", "CONTENTFUL_CLI": "#/components/schemas/ContentfulCliActionResponse", "WP_CLI": "#/components/schemas/WpCliActionResponse", "PROMOTE_IMAGE": "#/components/schemas/PromoteImageActionResponse", "GIT_MERGE": "#/components/schemas/GitMergeActionResponse", "MYSQL_CLI": "#/components/schemas/MysqlCliActionResponse", "POSTGRESQL_CLI": "#/components/schemas/PostgresqlCliActionResponse", "MONGOSH_CLI": "#/components/schemas/MongoshCliActionResponse", "MSSQL_CLI": "#/components/schemas/MssqlCliActionResponse", "CYPRESS": "#/components/schemas/CypressActionResponse", "PLAYWRIGHT": "#/components/schemas/PlaywrightActionResponse", "CRAWL": "#/components/schemas/CrawlActionResponse", "NPM_PUBLISH": "#/components/schemas/NpmPublishActionResponse", "CLAUDE_CODE": "#/components/schemas/ClaudeCodeActionResponse" } }, "oneOf": [ { "$ref": "#/components/schemas/BuildActionResponse" }, { "$ref": "#/components/schemas/EmailActionResponse" }, { "$ref": "#/components/schemas/AmazonS3ActionResponse" }, { "$ref": "#/components/schemas/SshCommandActionResponse" }, { "$ref": "#/components/schemas/HttpActionResponse" }, { "$ref": "#/components/schemas/VisualTestsActionResponse" }, { "$ref": "#/components/schemas/VisualTest2ActionResponse" }, { "$ref": "#/components/schemas/SlackActionResponse" }, { "$ref": "#/components/schemas/TelegramActionResponse" }, { "$ref": "#/components/schemas/DiscordActionResponse" }, { "$ref": "#/components/schemas/MicrosoftTeamsActionResponse" }, { "$ref": "#/components/schemas/GoogleChatActionResponse" }, { "$ref": "#/components/schemas/SmsActionResponse" }, { "$ref": "#/components/schemas/PushoverActionResponse" }, { "$ref": "#/components/schemas/PushbulletActionResponse" }, { "$ref": "#/components/schemas/HoneybadgerActionResponse" }, { "$ref": "#/components/schemas/NewRelicActionResponse" }, { "$ref": "#/components/schemas/RollbarActionResponse" }, { "$ref": "#/components/schemas/SentryActionResponse" }, { "$ref": "#/components/schemas/SentryActionResponse" }, { "$ref": "#/components/schemas/DatadogActionResponse" }, { "$ref": "#/components/schemas/DatadogStatusCheckActionResponse" }, { "$ref": "#/components/schemas/BugsnagActionResponse" }, { "$ref": "#/components/schemas/RaygunActionResponse" }, { "$ref": "#/components/schemas/LogglyActionResponse" }, { "$ref": "#/components/schemas/GhostInspectorActionResponse" }, { "$ref": "#/components/schemas/AtopActionResponse" }, { "$ref": "#/components/schemas/JiraBuildActionResponse" }, { "$ref": "#/components/schemas/JiraDeploymentActionResponse" }, { "$ref": "#/components/schemas/DoSpacesActionResponse" }, { "$ref": "#/components/schemas/BackblazeB2ActionResponse" }, { "$ref": "#/components/schemas/GcsActionResponse" }, { "$ref": "#/components/schemas/GcsActionResponse" }, { "$ref": "#/components/schemas/RackspaceActionResponse" }, { "$ref": "#/components/schemas/ShopifyActionResponse" }, { "$ref": "#/components/schemas/WebDavActionResponse" }, { "$ref": "#/components/schemas/TransferActionResponse" }, { "$ref": "#/components/schemas/AzureStorageActionResponse" }, { "$ref": "#/components/schemas/DeployToSandboxActionResponse" }, { "$ref": "#/components/schemas/PublishArtifactVersionActionResponse" }, { "$ref": "#/components/schemas/PowershellActionResponse" }, { "$ref": "#/components/schemas/SandboxExecActionResponse" }, { "$ref": "#/components/schemas/PushActionResponse" }, { "$ref": "#/components/schemas/AzureActionResponse" }, { "$ref": "#/components/schemas/HerokuActionResponse" }, { "$ref": "#/components/schemas/WebActionResponse" }, { "$ref": "#/components/schemas/TcpActionResponse" }, { "$ref": "#/components/schemas/PingActionResponse" }, { "$ref": "#/components/schemas/StorybookActionResponse" }, { "$ref": "#/components/schemas/CustomActionResponse" }, { "$ref": "#/components/schemas/RunDockerContainerActionResponse" }, { "$ref": "#/components/schemas/DockerfileActionResponse" }, { "$ref": "#/components/schemas/DockerBuildMultiArchActionResponse" }, { "$ref": "#/components/schemas/DockerPushActionResponse" }, { "$ref": "#/components/schemas/GoogleAppEngineActionResponse" }, { "$ref": "#/components/schemas/GoogleAppDeployActionResponse" }, { "$ref": "#/components/schemas/GoogleCloudCliActionResponse" }, { "$ref": "#/components/schemas/GoogleCloudCliActionResponse" }, { "$ref": "#/components/schemas/GoogleCloudRunDeployActionResponse" }, { "$ref": "#/components/schemas/GoogleCloudRunDeployActionResponse" }, { "$ref": "#/components/schemas/HerokuCliActionResponse" }, { "$ref": "#/components/schemas/AwsCliActionResponse" }, { "$ref": "#/components/schemas/AwsCli2ActionResponse" }, { "$ref": "#/components/schemas/AwsCloudFormationActionResponse" }, { "$ref": "#/components/schemas/AwsLambdaDeployActionResponse" }, { "$ref": "#/components/schemas/GoogleFunctionDeployActionResponse" }, { "$ref": "#/components/schemas/GoogleFunctionDeployActionResponse" }, { "$ref": "#/components/schemas/RunNextPipelineActionResponse" }, { "$ref": "#/components/schemas/CopyFilesActionResponse" }, { "$ref": "#/components/schemas/WaitForApplyActionResponse" }, { "$ref": "#/components/schemas/WaitForVariablesActionResponse" }, { "$ref": "#/components/schemas/SetVariablesActionResponse" }, { "$ref": "#/components/schemas/ApproveVtActionResponse" }, { "$ref": "#/components/schemas/AwsElasticBeanstalkActionResponse" }, { "$ref": "#/components/schemas/AwsCodeDeployActionResponse" }, { "$ref": "#/components/schemas/AwsAppRunnerDeployActionResponse" }, { "$ref": "#/components/schemas/AwsEcsActionResponse" }, { "$ref": "#/components/schemas/AwsLambdaInvokeActionResponse" }, { "$ref": "#/components/schemas/GoogleFunctionInvokeActionResponse" }, { "$ref": "#/components/schemas/GoogleFunctionInvokeActionResponse" }, { "$ref": "#/components/schemas/CloudflareInvalidationActionResponse" }, { "$ref": "#/components/schemas/CloudFrontInvalidationActionResponse" }, { "$ref": "#/components/schemas/GoogleCdnInvalidationActionResponse" }, { "$ref": "#/components/schemas/GoogleCdnInvalidationActionResponse" }, { "$ref": "#/components/schemas/DigitalOceanCdnInvalidationActionResponse" }, { "$ref": "#/components/schemas/RsyncActionResponse" }, { "$ref": "#/components/schemas/AwsElasticBeanstalkMonitorActionResponse" }, { "$ref": "#/components/schemas/AwsAppRunnerMonitorActionResponse" }, { "$ref": "#/components/schemas/SleepActionResponse" }, { "$ref": "#/components/schemas/KubernetesApplyActionResponse" }, { "$ref": "#/components/schemas/KubernetesSetImageActionResponse" }, { "$ref": "#/components/schemas/KubernetesRunPodActionResponse" }, { "$ref": "#/components/schemas/KubernetesRunJobActionResponse" }, { "$ref": "#/components/schemas/KubernetesCliActionResponse" }, { "$ref": "#/components/schemas/HelmActionResponse" }, { "$ref": "#/components/schemas/ZipActionResponse" }, { "$ref": "#/components/schemas/EslintActionResponse" }, { "$ref": "#/components/schemas/AndroidSignActionResponse" }, { "$ref": "#/components/schemas/AndroidSignBundleActionResponse" }, { "$ref": "#/components/schemas/AndroidUploadApkActionResponse" }, { "$ref": "#/components/schemas/AndroidUploadBundleActionResponse" }, { "$ref": "#/components/schemas/AndroidPublishApkActionResponse" }, { "$ref": "#/components/schemas/AndroidPublishAppBundleActionResponse" }, { "$ref": "#/components/schemas/FirebaseActionResponse" }, { "$ref": "#/components/schemas/NetlifyActionResponse" }, { "$ref": "#/components/schemas/LighthouseActionResponse" }, { "$ref": "#/components/schemas/ReplaceActionResponse" }, { "$ref": "#/components/schemas/GitCryptActionResponse" }, { "$ref": "#/components/schemas/GitCryptActionResponse" }, { "$ref": "#/components/schemas/SplitTestsActionResponse" }, { "$ref": "#/components/schemas/ImageCompressionActionResponse" }, { "$ref": "#/components/schemas/DockerfileLinterActionResponse" }, { "$ref": "#/components/schemas/DownloadFtpActionResponse" }, { "$ref": "#/components/schemas/DownloadS3ActionResponse" }, { "$ref": "#/components/schemas/DownloadFromSandboxActionResponse" }, { "$ref": "#/components/schemas/DownloadFromGcsActionResponse" }, { "$ref": "#/components/schemas/DownloadBackblazeActionResponse" }, { "$ref": "#/components/schemas/DownloadArtifactActionResponse" }, { "$ref": "#/components/schemas/SandboxStartActionResponse" }, { "$ref": "#/components/schemas/SandboxStopActionResponse" }, { "$ref": "#/components/schemas/SandboxSnapshotActionResponse" }, { "$ref": "#/components/schemas/SandboxCreateNewActionResponse" }, { "$ref": "#/components/schemas/SandboxCreateFromSandboxActionResponse" }, { "$ref": "#/components/schemas/SandboxCreateFromSnapshotActionResponse" }, { "$ref": "#/components/schemas/SandboxDeleteActionResponse" }, { "$ref": "#/components/schemas/SandboxApplicationStartActionResponse" }, { "$ref": "#/components/schemas/SandboxApplicationStopActionResponse" }, { "$ref": "#/components/schemas/ManageSandboxActionResponse" }, { "$ref": "#/components/schemas/CreateSandboxActionResponse" }, { "$ref": "#/components/schemas/LinkValidatorActionResponse" }, { "$ref": "#/components/schemas/LinkCheckerActionResponse" }, { "$ref": "#/components/schemas/AzureCliActionResponse" }, { "$ref": "#/components/schemas/ShopifyThemekitActionResponse" }, { "$ref": "#/components/schemas/ShopifyCliActionResponse" }, { "$ref": "#/components/schemas/SslVerifyActionResponse" }, { "$ref": "#/components/schemas/GitHubReleaseActionResponse" }, { "$ref": "#/components/schemas/WindowsNativeBuildActionResponse" }, { "$ref": "#/components/schemas/MacNativeBuildActionResponse" }, { "$ref": "#/components/schemas/MacVmNativeBuildActionResponse" }, { "$ref": "#/components/schemas/MacReactNativeBuildActionResponse" }, { "$ref": "#/components/schemas/MacCordovaNativeBuildActionResponse" }, { "$ref": "#/components/schemas/MacFastlaneNativeBuildActionResponse" }, { "$ref": "#/components/schemas/MacFlutterNativeBuildActionResponse" }, { "$ref": "#/components/schemas/MacSignNativeBuildActionResponse" }, { "$ref": "#/components/schemas/MacDeployNativeBuildActionResponse" }, { "$ref": "#/components/schemas/DockerCliNativeBuildActionResponse" }, { "$ref": "#/components/schemas/LinuxNativeBuildActionResponse" }, { "$ref": "#/components/schemas/DoctlActionResponse" }, { "$ref": "#/components/schemas/ClearCacheActionResponse" }, { "$ref": "#/components/schemas/FastlaneAndroidActionResponse" }, { "$ref": "#/components/schemas/GitHubCliActionResponse" }, { "$ref": "#/components/schemas/GitLabCliActionResponse" }, { "$ref": "#/components/schemas/IntegrationVariablesActionResponse" }, { "$ref": "#/components/schemas/CodePipelineActionResponse" }, { "$ref": "#/components/schemas/AwsCdkCliActionResponse" }, { "$ref": "#/components/schemas/GhostInspectorCliActionResponse" }, { "$ref": "#/components/schemas/TerraformActionResponse" }, { "$ref": "#/components/schemas/SnykActionResponse" }, { "$ref": "#/components/schemas/StackHawkActionResponse" }, { "$ref": "#/components/schemas/JmeterActionResponse" }, { "$ref": "#/components/schemas/TrivyCliActionResponse" }, { "$ref": "#/components/schemas/BlackfirePhpActionResponse" }, { "$ref": "#/components/schemas/BlackfirePythonActionResponse" }, { "$ref": "#/components/schemas/BlackfireGoActionResponse" }, { "$ref": "#/components/schemas/DockerCliActionResponse" }, { "$ref": "#/components/schemas/PipelineSettingsActionResponse" }, { "$ref": "#/components/schemas/NewRelicCliActionResponse" }, { "$ref": "#/components/schemas/ContentfulCliActionResponse" }, { "$ref": "#/components/schemas/WpCliActionResponse" }, { "$ref": "#/components/schemas/PromoteImageActionResponse" }, { "$ref": "#/components/schemas/GitMergeActionResponse" }, { "$ref": "#/components/schemas/MysqlCliActionResponse" }, { "$ref": "#/components/schemas/PostgresqlCliActionResponse" }, { "$ref": "#/components/schemas/MongoshCliActionResponse" }, { "$ref": "#/components/schemas/MssqlCliActionResponse" }, { "$ref": "#/components/schemas/CypressActionResponse" }, { "$ref": "#/components/schemas/PlaywrightActionResponse" }, { "$ref": "#/components/schemas/CrawlActionResponse" }, { "$ref": "#/components/schemas/NpmPublishActionResponse" }, { "$ref": "#/components/schemas/ClaudeCodeActionResponse" } ] }, "AmazonS3ActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "local_path": { "type": "string", "description": "The path to the local files to deploy" }, "remote_path": { "type": "string", "description": "The path on the remote server where files will be deployed" }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "deployment_includes": { "type": "array", "description": "The list of files or directories to include in deployment", "items": { "type": "string", "description": "The list of files or directories to include in deployment" } }, "input_type": { "type": "string", "description": "The type of source input", "enum": [ "SCM_REPOSITORY", "BUILD_ARTIFACTS" ] }, "deletion_disabled": { "type": "boolean", "description": "If set to `true`, files on the remote server will not be deleted" }, "use_temporary_files": { "type": "boolean", "description": "If set to `true`, files will be uploaded to a temporary directory first" }, "content_encoding": { "type": "string", "description": "The content encoding for deployed files" }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "bucket_name": { "type": "string", "description": "The name of the Amazon S3 Bucket" }, "public_access": { "type": "boolean", "description": "Defines whether the bucket has public access" }, "acl": { "type": "string", "description": "Controls bucket access permissions", "enum": [ "PRIVATE", "PUBLIC_READ", "PUBLIC_READ_WRITE", "AWS_EXEC_READ", "AUTHENTICATED_READ", "BUCKET_OWNER_READ", "BUCKET_OWNER_FULL_CONTROL", "LOG_DELIVERY_WRITE" ] }, "reduced_redundancy": { "type": "boolean", "description": "Set to `true` if you want to use Reduced Redundancy Storage" }, "cache_control": { "type": "string", "description": "Specifies how long objects stay in the cache" }, "expires_date": { "type": "string", "description": "Specifies the expiration period for the objects (how long they stay in the cache)", "format": "date-time" }, "skip_content_type_setting": { "type": "boolean", "description": "When set to `true` all files will have their mime-types set to `application/octet-stream`" }, "deploy_tags": { "type": "array", "description": "Defines tags for files categorization as a key value pairs list", "items": { "$ref": "#/components/schemas/DeploymentTagView" } } } }, "AndroidPublishApkActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "application_id": { "type": "string", "description": "The ID of the Android Application" }, "track": { "type": "string", "description": "The track type to read or modify" }, "user_fraction": { "type": "number", "description": "Portion of the users who should get the staged rollout version of the APK (range 0.0 - 1.0)", "format": "double" }, "mapping_path": { "type": "string", "description": "The path to the deobfuscated file of the specified APK" }, "changes_path": { "type": "string", "description": "The path to the changelog file" }, "supersede_versions": { "type": "boolean", "description": "Check and disable superseded versions in other tracks (if any)" }, "draft": { "type": "boolean", "description": "Set to `true` to publish as a draft" }, "changes_not_sent_for_review": { "type": "boolean", "description": "If set to `true`, changes will not be sent for review" }, "apk_files": { "uniqueItems": true, "type": "array", "description": "The list of sets of paths to the APKs", "items": { "$ref": "#/components/schemas/ApkFileView" } }, "key_path": { "type": "string", "description": "The path to the service account key file" }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" } } }, "AndroidPublishAppBundleActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "application_id": { "type": "string", "description": "The ID of the Android Application" }, "track": { "type": "string", "description": "The track type to read or modify" }, "user_fraction": { "type": "number", "description": "Portion of the users who should get the staged rollout version of the APK (range 0.0 - 1.0)", "format": "double" }, "mapping_path": { "type": "string", "description": "The path to the deobfuscated file of the specified APK" }, "changes_path": { "type": "string", "description": "The path to the changelog file" }, "supersede_versions": { "type": "boolean", "description": "Check and disable superseded versions in other tracks (if any)" }, "draft": { "type": "boolean", "description": "Set to `true` to publish as a draft" }, "changes_not_sent_for_review": { "type": "boolean", "description": "If set to `true`, changes will not be sent for review" }, "apk_files": { "uniqueItems": true, "type": "array", "description": "The list of sets of paths to the APKs", "items": { "$ref": "#/components/schemas/ApkFileView" } }, "key_path": { "type": "string", "description": "The path to the service account key file" }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" } } }, "AndroidSignActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "local_path": { "type": "string", "description": "The path to the Android application file (APK or AAB)" }, "application_name": { "type": "string", "description": "The name of the Android application" }, "output_dir": { "type": "string", "description": "The directory where the signed application will be saved" }, "key_path": { "type": "string", "description": "The path to the keystore file" }, "key_alias": { "type": "string", "description": "The alias of the key in the keystore" }, "key_password": { "type": "string", "description": "The password for the key" }, "keystore_password": { "type": "string", "description": "The password for the keystore" }, "build_tool_version": { "type": "string", "description": "The version of the Android Build Tools" } } }, "AndroidSignBundleActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "local_path": { "type": "string", "description": "The path to the Android application file (APK or AAB)" }, "application_name": { "type": "string", "description": "The name of the Android application" }, "output_dir": { "type": "string", "description": "The directory where the signed application will be saved" }, "key_path": { "type": "string", "description": "The path to the keystore file" }, "key_alias": { "type": "string", "description": "The alias of the key in the keystore" }, "key_password": { "type": "string", "description": "The password for the key" }, "keystore_password": { "type": "string", "description": "The password for the keystore" } } }, "AndroidUploadApkActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "application_id": { "type": "string", "description": "The ID of the Android Application" }, "track": { "type": "string", "description": "The track type to read or modify" }, "user_fraction": { "type": "number", "description": "Portion of the users who should get the staged rollout version of the APK (range 0.0 - 1.0)", "format": "double" }, "mapping_path": { "type": "string", "description": "The path to the deobfuscated file of the specified APK" }, "changes_path": { "type": "string", "description": "The path to the changelog file" }, "supersede_versions": { "type": "boolean", "description": "Check and disable superseded versions in other tracks (if any)" }, "draft": { "type": "boolean", "description": "Set to `true` to publish as a draft" }, "changes_not_sent_for_review": { "type": "boolean", "description": "If set to `true`, changes will not be sent for review" }, "apk_files": { "uniqueItems": true, "type": "array", "description": "The list of sets of paths to the APKs", "items": { "$ref": "#/components/schemas/ApkFileView" } }, "key_path": { "type": "string", "description": "The path to the service account key file" } } }, "AndroidUploadBundleActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "application_id": { "type": "string", "description": "The ID of the Android Application" }, "track": { "type": "string", "description": "The track type to read or modify" }, "user_fraction": { "type": "number", "description": "Portion of the users who should get the staged rollout version of the APK (range 0.0 - 1.0)", "format": "double" }, "mapping_path": { "type": "string", "description": "The path to the deobfuscated file of the specified APK" }, "changes_path": { "type": "string", "description": "The path to the changelog file" }, "supersede_versions": { "type": "boolean", "description": "Check and disable superseded versions in other tracks (if any)" }, "draft": { "type": "boolean", "description": "Set to `true` to publish as a draft" }, "changes_not_sent_for_review": { "type": "boolean", "description": "If set to `true`, changes will not be sent for review" }, "apk_files": { "uniqueItems": true, "type": "array", "description": "The list of sets of paths to the APKs", "items": { "$ref": "#/components/schemas/ApkFileView" } }, "key_path": { "type": "string", "description": "The path to the service account key file" } } }, "ApproveVtActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "comment": { "type": "string", "description": "The comment for the wait action" }, "description": { "type": "string", "description": "The description of the wait action" }, "prevent_self_approval": { "type": "boolean", "description": "If set to `true`, the approver must be different from the person who triggered the run. Default: `false`." }, "from_action": { "type": "string", "description": "The ID of the action from which visual test results are retrieved" }, "suite": { "type": "string", "description": "The name of the visual test suite to approve" }, "ref": { "type": "string", "description": "The git reference (branch, tag, or commit) for which to approve visual test results" } } }, "AtopActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "api_url": { "type": "string", "description": "The URL of the ATOP API endpoint" }, "parameters": { "type": "array", "description": "The list of parameters to send with the ATOP notification", "items": { "$ref": "#/components/schemas/Parameter" } } } }, "AwsAppRunnerDeployActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "region": { "type": "string", "description": "The AWS region where the App Runner service is located" }, "service": { "type": "string", "description": "The ID of the App Runner service ARN" } } }, "AwsAppRunnerMonitorActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "region": { "type": "string", "description": "The region to monitor" }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "service": { "type": "string", "description": "The ID of the App Runner service ARN" } } }, "AwsCdkCliActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "region": { "type": "string", "description": "The name of the Amazon region" } } }, "AwsCli2ActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "region": { "type": "string", "description": "The Amazon S3 region" } } }, "AwsCliActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "region": { "type": "string", "description": "The Amazon S3 region" } } }, "AwsCloudFormationActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "region": { "type": "string", "description": "The Amazon region" } } }, "AwsCodeDeployActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "region": { "type": "string", "description": "The AWS region" }, "local_path": { "type": "string", "description": "The path to the local files to deploy" }, "application_name": { "type": "string", "description": "The name of the AWS application" }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "deployment_includes": { "type": "array", "description": "The list of files or directories to include in deployment", "items": { "type": "string", "description": "The list of files or directories to include in deployment" } }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "version_label": { "type": "string", "description": "The version label for the deployment" }, "group_name": { "type": "string", "description": "The name of the deployment group" }, "config_name": { "type": "string", "description": "The name of the deployment configuration" }, "description": { "type": "string", "description": "The description of the deployment" }, "ignore_application_stop_failures": { "type": "boolean", "description": "If set to `true`, application stop failures will be ignored" }, "update_outdated_instances_only": { "type": "boolean", "description": "If set to `true`, only outdated instances will be updated" }, "wait_for_finish_deployment": { "type": "boolean", "description": "If set to `true`, the action will wait for the deployment to finish" }, "file_exist_behavior": { "type": "string", "description": "The behavior when files already exist" }, "bucket_name": { "type": "string", "description": "The name of the S3 bucket for deployment" } } }, "AwsEcsActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "region": { "type": "string", "description": "The Amazon region" }, "local_path": { "type": "string", "description": "The path to the JSON file with task definition" }, "cluster": { "type": "string", "description": "The name of the ECS cluster" }, "service": { "type": "string", "description": "The ID of the ECS service" } } }, "AwsElasticBeanstalkActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "region": { "type": "string", "description": "The AWS region" }, "local_path": { "type": "string", "description": "The path to the local files to deploy" }, "application_name": { "type": "string", "description": "The name of the AWS application" }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "deployment_includes": { "type": "array", "description": "The list of files or directories to include in deployment", "items": { "type": "string", "description": "The list of files or directories to include in deployment" } }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "environment": { "type": "string", "description": "The name of the Elastic Beanstalk environment" }, "version_label": { "type": "string", "description": "The version label for the deployment" }, "bucket_name": { "type": "string", "description": "The name of the S3 bucket for deployment" } } }, "AwsElasticBeanstalkMonitorActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "region": { "type": "string", "description": "The region to monitor" }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "application_name": { "type": "string", "description": "The name of the Elastic Beanstalk application to monitor" }, "environment": { "type": "string", "description": "The name of the Elastic Beanstalk environment to monitor" }, "fail_on_yellow": { "type": "boolean", "description": "If set to `true`, the action will fail when the environment health status is Yellow" }, "verbose": { "type": "boolean", "description": "If set to `true`, detailed monitoring information will be displayed" } } }, "AwsLambdaDeployActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "region": { "type": "string", "description": "The Amazon region" }, "local_path": { "type": "string", "description": "The path in the repository" }, "function_name": { "type": "string", "description": "The name of the Lambda function" }, "deployment_excludes": { "type": "array", "description": "The paths and/or files that will be left out during the deployment", "items": { "type": "string", "description": "The paths and/or files that will be left out during the deployment" } }, "deployment_includes": { "type": "array", "description": "The exceptions from the ignore patterns set in `deployment_excludes`", "items": { "type": "string", "description": "The exceptions from the ignore patterns set in `deployment_excludes`" } } } }, "AwsLambdaInvokeActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "function_name": { "type": "string", "description": "The name of the function to invoke" }, "region": { "type": "string", "description": "The region where the function is located" }, "payload": { "type": "string", "description": "The payload to send to the function" }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "qualifier": { "type": "string", "description": "The version or alias to invoke. If not specified, the latest version is used" }, "invocation_type": { "type": "string", "description": "The invocation type. Can be `RequestResponse` (default), `Event`, or `DryRun`" }, "log_type": { "type": "string", "description": "Set to `Tail` to include the execution log in the response" }, "client_context": { "type": "string", "description": "Client-specific information passed to the Lambda function" } } }, "AzureActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "push_tags": { "type": "boolean", "description": "If set to `true`, tags will be pushed to the repository" }, "push_only_tags": { "type": "boolean", "description": "If set to `true`, only tags will be pushed without commits" }, "target_branch": { "type": "string", "description": "The target branch to push to" }, "without_force": { "type": "boolean", "description": "If set to `true`, force push will not be used" }, "isolated": { "type": "boolean", "description": "If set to `true`, the action will run in an isolated environment" }, "use_custom_gitignore": { "type": "boolean", "description": "If set to `true`, custom .gitignore rules will be used" }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "comment": { "type": "string", "description": "The commit message for the push" }, "tag": { "type": "string", "description": "The tag name to create and push" }, "custom_options": { "type": "string", "description": "Custom git push options" }, "targets": { "type": "array", "description": "The list of target repositories to push to", "items": { "$ref": "#/components/schemas/TargetView" } }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "push_url": { "type": "string", "description": "The URL of the Azure Git repository to push to" }, "login": { "type": "string", "description": "The username for Azure authentication" }, "env_key": { "type": "string", "description": "The name of the environment variable containing the private key" }, "password": { "type": "string", "description": "The password for Azure authentication" }, "server_key": { "type": "string", "description": "The private SSH key for Azure authentication" }, "git_auth_mode": { "type": "string", "description": "The authentication mode for Git operations", "enum": [ "HTTP", "PRIVATE_KEY", "PUBLIC_BUDDY_KEY", "ENV_KEY", "CURRENT" ] } } }, "AzureCliActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" } } }, "AzureStorageActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "local_path": { "type": "string", "description": "The path to the local files to deploy" }, "remote_path": { "type": "string", "description": "The path on the remote server where files will be deployed" }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "deployment_includes": { "type": "array", "description": "The list of files or directories to include in deployment", "items": { "type": "string", "description": "The list of files or directories to include in deployment" } }, "input_type": { "type": "string", "description": "The type of source input", "enum": [ "SCM_REPOSITORY", "BUILD_ARTIFACTS" ] }, "deletion_disabled": { "type": "boolean", "description": "If set to `true`, files on the remote server will not be deleted" }, "use_temporary_files": { "type": "boolean", "description": "If set to `true`, files will be uploaded to a temporary directory first" }, "content_encoding": { "type": "string", "description": "The content encoding for deployed files" }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "application_name": { "type": "string", "description": "The name of the Azure Storage application" }, "bucket_name": { "type": "string", "description": "The name of the Azure Storage container" }, "skip_content_type_setting": { "type": "boolean", "description": "When set to `true`, content type detection will be skipped" } } }, "BackblazeB2ActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "local_path": { "type": "string", "description": "The path to the local files to deploy" }, "remote_path": { "type": "string", "description": "The path on the remote server where files will be deployed" }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "deployment_includes": { "type": "array", "description": "The list of files or directories to include in deployment", "items": { "type": "string", "description": "The list of files or directories to include in deployment" } }, "input_type": { "type": "string", "description": "The type of source input", "enum": [ "SCM_REPOSITORY", "BUILD_ARTIFACTS" ] }, "deletion_disabled": { "type": "boolean", "description": "If set to `true`, files on the remote server will not be deleted" }, "use_temporary_files": { "type": "boolean", "description": "If set to `true`, files will be uploaded to a temporary directory first" }, "content_encoding": { "type": "string", "description": "The content encoding for deployed files" }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "bucket_name": { "type": "string", "description": "The name of the Backblaze B2 bucket" }, "cache_control": { "type": "string", "description": "The Cache-Control header value for uploaded files" }, "region": { "type": "string", "description": "The Backblaze B2 region" } } }, "BlackfireGoActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "version": { "type": "string", "description": "The version of GO" } } }, "BlackfirePhpActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "version": { "type": "string", "description": "The version of PHP" } } }, "BlackfirePythonActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "version": { "type": "string", "description": "The version of Python" } } }, "BugsnagActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "token": { "type": "string", "description": "See `apiKey` [here](https://bugsnagbuildapi.docs.apiary.io/#reference/0/build/notify-of-a-build)" }, "version": { "type": "string", "description": "See `appVersion` [here](https://bugsnagbuildapi.docs.apiary.io/#reference/0/build/notify-of-a-build)" }, "builder_name": { "type": "string", "description": "See `builderName` [here](https://bugsnagbuildapi.docs.apiary.io/#reference/0/build/notify-of-a-build)" }, "release_stage": { "type": "string", "description": "See `releaseStage` [here](https://bugsnagbuildapi.docs.apiary.io/#reference/0/build/notify-of-a-build)" }, "revision": { "type": "string", "description": "See `sourceControl.revision` [here](https://bugsnagbuildapi.docs.apiary.io/#/reference/0/build)" }, "auto_assign_release": { "type": "boolean", "description": "See `autoAssignRelease` [here](https://bugsnagbuildapi.docs.apiary.io/#reference/0/build/notify-of-a-build)" } } }, "BuildActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "working_directory": { "type": "string", "description": "The directory in which the pipeline filesystem will be mounted" }, "main_service_name": { "type": "string", "description": "The hostname of the container in which the action is run. The container will be available under this name in the docker network for services" }, "run_as_user": { "type": "string", "description": "All build commands are run as the default user defined in the selected Docker image. Can be set to another username (on the condition that this user exists in the selected image)" }, "version": { "type": "string", "description": "The version of the artifact from artifact registry" }, "docker_image_name": { "type": "string", "description": "The name of the Docker image" }, "docker_image_tag": { "type": "string", "description": "The tag of the Docker image" }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "mount_filesystem_disable": { "type": "boolean", "description": "If set to `true`, the filesystem will not be mounted in the container" }, "volume_mappings": { "type": "array", "description": "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)", "items": { "type": "string", "description": "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)" } }, "cached_dirs": { "type": "array", "description": "The dependencies & directories to be cached and available to every execution in this pipeline", "items": { "type": "string", "description": "The dependencies & directories to be cached and available to every execution in this pipeline" } }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "services": { "type": "array", "description": "The list of services attached to the build environment", "items": { "$ref": "#/components/schemas/ServiceView" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "registry": { "type": "string", "description": "The URL of the Docker registry" }, "insecure_registry": { "type": "boolean", "description": "If set to `true`, the registry will be accessed over HTTP instead of HTTPS" }, "login": { "type": "string", "description": "The username for the Docker registry" }, "target_stage": { "type": "string", "description": "The target stage of the Dockerfile" }, "password": { "type": "string", "description": "The password for the Docker registry" }, "region": { "type": "string", "description": "The region for the Docker registry (for AWS ECR)" }, "image_location": { "type": "string", "description": "The location of the image used by the action", "enum": [ "PUBLIC_REGISTRY", "PRIVATE_REGISTRY", "ACTION", "ARTIFACT_REGISTRY" ] }, "docker_registry": { "type": "string", "description": "The type of registry from which the image is retrieved", "enum": [ "NONE", "DOCKER_HUB", "AMAZON_ECR", "GOOGLE_GCR", "GOOGLE_ARTIFACT_REGISTRY", "OTHER", "GIT_HUB_CONTAINER_REGISTRY", "ARTIFACT_REGISTRY", "DIGITAL_OCEAN_CONTAINER_REGISTRY" ] }, "docker_build_action_id": { "type": "integer", "description": "The ID of the action from which the Docker image will be used", "format": "int32" }, "docker_build_action_name": { "type": "string", "description": "The name of the action from which the Docker image will be used" }, "export_container_path": { "type": "string", "description": "The path in the container to export" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "ignore_image_pull_failures": { "type": "boolean", "description": "If set to `true`, use cached image on timeouts (only for official images)" }, "cache_base_image": { "type": "boolean", "description": "If set to `true`, the cached version of the image is used, instead of being pulled each time" }, "reset_entrypoint": { "type": "boolean", "description": "If set to `true`, resets the default entrypoint set by the image. Default value: `false`" }, "vt_suite": { "type": "string", "description": "The visual tests suite identifier" }, "unit_tests_suite": { "type": "string", "description": "The unit tests suite identifier" }, "unit_tests_path": { "type": "string", "description": "The path to the unit tests results" }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "artifact": { "type": "string", "description": "The identifier of the artifact from artifact registry" } } }, "ClaudeCodeActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "working_directory": { "type": "string", "description": "The directory in which the pipeline filesystem will be mounted" }, "main_service_name": { "type": "string", "description": "The hostname of the container in which the action is run. The container will be available under this name in the docker network for services" }, "run_as_user": { "type": "string", "description": "All build commands are run as the default user defined in the selected Docker image. Can be set to another username (on the condition that this user exists in the selected image)" }, "version": { "type": "string", "description": "The version of the artifact from artifact registry" }, "docker_image_name": { "type": "string", "description": "The name of the Docker image" }, "docker_image_tag": { "type": "string", "description": "The tag of the Docker image" }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "mount_filesystem_disable": { "type": "boolean", "description": "If set to `true`, the filesystem will not be mounted in the container" }, "volume_mappings": { "type": "array", "description": "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)", "items": { "type": "string", "description": "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)" } }, "cached_dirs": { "type": "array", "description": "The dependencies & directories to be cached and available to every execution in this pipeline", "items": { "type": "string", "description": "The dependencies & directories to be cached and available to every execution in this pipeline" } }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "services": { "type": "array", "description": "The list of services attached to the build environment", "items": { "$ref": "#/components/schemas/ServiceView" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "registry": { "type": "string", "description": "The URL of the Docker registry" }, "insecure_registry": { "type": "boolean", "description": "If set to `true`, the registry will be accessed over HTTP instead of HTTPS" }, "login": { "type": "string", "description": "The username for the Docker registry" }, "target_stage": { "type": "string", "description": "The target stage of the Dockerfile" }, "password": { "type": "string", "description": "The password for the Docker registry" }, "region": { "type": "string", "description": "The region for the Docker registry (for AWS ECR)" }, "image_location": { "type": "string", "description": "The location of the image used by the action", "enum": [ "PUBLIC_REGISTRY", "PRIVATE_REGISTRY", "ACTION", "ARTIFACT_REGISTRY" ] }, "docker_registry": { "type": "string", "description": "The type of registry from which the image is retrieved", "enum": [ "NONE", "DOCKER_HUB", "AMAZON_ECR", "GOOGLE_GCR", "GOOGLE_ARTIFACT_REGISTRY", "OTHER", "GIT_HUB_CONTAINER_REGISTRY", "ARTIFACT_REGISTRY", "DIGITAL_OCEAN_CONTAINER_REGISTRY" ] }, "docker_build_action_id": { "type": "integer", "description": "The ID of the action from which the Docker image will be used", "format": "int32" }, "docker_build_action_name": { "type": "string", "description": "The name of the action from which the Docker image will be used" }, "export_container_path": { "type": "string", "description": "The path in the container to export" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "ignore_image_pull_failures": { "type": "boolean", "description": "If set to `true`, use cached image on timeouts (only for official images)" }, "cache_base_image": { "type": "boolean", "description": "If set to `true`, the cached version of the image is used, instead of being pulled each time" }, "reset_entrypoint": { "type": "boolean", "description": "If set to `true`, resets the default entrypoint set by the image. Default value: `false`" }, "vt_suite": { "type": "string", "description": "The visual tests suite identifier" }, "unit_tests_suite": { "type": "string", "description": "The unit tests suite identifier" }, "unit_tests_path": { "type": "string", "description": "The path to the unit tests results" }, "prompts": { "type": "array", "description": "List of prompts to send to Claude Code. Each prompt has a `type` (`INLINE` or `FILE`) and a `value`.", "items": { "$ref": "#/components/schemas/LlmBuildPromptView" } }, "model": { "type": "string", "description": "The Claude model to use (e.g. `sonnet`, `opus`, `haiku`)." }, "settings": { "$ref": "#/components/schemas/ClaudeCodeSettingsView" }, "claude_args": { "type": "string", "description": "Additional CLI arguments passed to Claude Code." }, "dangerously_skip_permissions": { "type": "boolean", "description": "If `true`, skip permission prompts (runs with `--dangerously-skip-permissions`)." }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "artifact": { "type": "string", "description": "The identifier of the artifact from artifact registry" } } }, "ClearCacheActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "cache_types": { "type": "array", "description": "Defines the cache layer cleared by the action", "items": { "type": "string", "description": "Defines the cache layer cleared by the action", "enum": [ "FILE_SYSTEM", "DOCKER", "SERVICES", "ADDITIONAL", "DOCKER_CLI" ] } } } }, "CloudFrontInvalidationActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "purge_all": { "type": "boolean", "description": "If set to `true`, all cached content will be purged" }, "purge_by_change_set_limit": { "type": "integer", "description": "The maximum number of files in the changeset to trigger purge", "format": "int32" }, "local_path": { "type": "string", "description": "The path to the local files to invalidate" }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from cache invalidation", "items": { "type": "string", "description": "The list of files or directories to exclude from cache invalidation" } }, "deployment_includes": { "type": "array", "description": "The list of files or directories to include in cache invalidation", "items": { "type": "string", "description": "The list of files or directories to include in cache invalidation" } }, "paths": { "type": "array", "description": "The list of paths to invalidate", "items": { "type": "string", "description": "The list of paths to invalidate" } }, "input_type": { "type": "string", "description": "The type of source input for invalidation (`SCM` or `BUILD_ARTIFACTS`)", "enum": [ "SCM_REPOSITORY", "BUILD_ARTIFACTS" ] }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "distribution_id": { "type": "string", "description": "The ID of the CloudFront web distribution" }, "base_url": { "type": "string", "description": "The base URL for the CloudFront distribution" } } }, "CloudflareInvalidationActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "purge_all": { "type": "boolean", "description": "If set to `true`, all cached content will be purged" }, "purge_by_change_set_limit": { "type": "integer", "description": "The maximum number of files in the changeset to trigger purge", "format": "int32" }, "local_path": { "type": "string", "description": "The path to the local files to invalidate" }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from cache invalidation", "items": { "type": "string", "description": "The list of files or directories to exclude from cache invalidation" } }, "deployment_includes": { "type": "array", "description": "The list of files or directories to include in cache invalidation", "items": { "type": "string", "description": "The list of files or directories to include in cache invalidation" } }, "paths": { "type": "array", "description": "The list of paths to invalidate", "items": { "type": "string", "description": "The list of paths to invalidate" } }, "input_type": { "type": "string", "description": "The type of source input for invalidation (`SCM` or `BUILD_ARTIFACTS`)", "enum": [ "SCM_REPOSITORY", "BUILD_ARTIFACTS" ] }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "zone": { "type": "string", "description": "The Cloudflare zone name" }, "base_url": { "type": "string", "description": "The base URL for the Cloudflare zone" }, "hosts": { "type": "array", "description": "Hosts specifying objects to invalidate", "items": { "type": "string", "description": "Hosts specifying objects to invalidate" } }, "prefixes": { "type": "array", "description": "Prefixes specifying objects to invalidate", "items": { "type": "string", "description": "Prefixes specifying objects to invalidate" } }, "tags": { "type": "array", "description": "Tags specifying objects to invalidate", "items": { "type": "string", "description": "Tags specifying objects to invalidate" } } } }, "CodePipelineActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "code_pipeline_name": { "type": "string", "description": "The name of the AWS CodePipeline pipeline triggered by the action" }, "region": { "type": "string", "description": "The Amazon region" }, "wait_for_complete": { "type": "boolean", "description": "If set to `true`, the action will wait for the CodePipeline to finish" } } }, "ContentfulCliActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "space": { "type": "string", "description": "The Contentful space ID where the operations will be performed" }, "environment": { "type": "string", "description": "The ID of the environment" } } }, "CopyFilesActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "source_pipeline": { "$ref": "#/components/schemas/PipelineIdentifierView" }, "target_pipeline": { "$ref": "#/components/schemas/PipelineIdentifierView" }, "source_path": { "type": "string", "description": "The path in the source pipeline's filesystem" }, "target_path": { "type": "string", "description": "The path in the current pipeline's filesystem" }, "deployment_excludes": { "type": "array", "description": "The paths and/or files that will be left out during the deployment", "items": { "type": "string", "description": "The paths and/or files that will be left out during the deployment" } }, "deployment_includes": { "type": "array", "description": "The exceptions from the ignore patterns set in `deployment_excludes`", "items": { "type": "string", "description": "The exceptions from the ignore patterns set in `deployment_excludes`" } }, "copy_hidden_files": { "type": "boolean", "description": "When set to `true` the hidden files and folders (the ones with the name beginning with a \".\") are copied" }, "delete_extra_files": { "type": "boolean", "description": "When set to `true`, files present in the target but not in the source will be deleted" } } }, "CrawlActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "URL to crawl (optional; defaults to crawl suite URL)" }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "crawl_suite": { "type": "string", "description": "The crawl suite identifier" }, "follow": { "type": "boolean", "description": "Crawl all subviews of the page. Default: false" }, "respect_robots": { "type": "boolean", "description": "Respect robots.txt. Default: false" }, "outputs": { "type": "array", "description": "Output types to produce (type, selector, quality, fullPage)", "items": { "$ref": "#/components/schemas/CrawlOutputView" } }, "browsers": { "type": "array", "description": "Browsers to use (e.g., CHROMIUM, FIREFOX, WEBKIT)", "items": { "type": "string", "description": "Browsers to use (e.g., CHROMIUM, FIREFOX, WEBKIT)" } }, "color_scheme": { "type": "string", "description": "Color scheme to use (LIGHT, DARK, LIGHT_AND_DARK)" }, "delays": { "type": "array", "description": "Add delay in milliseconds before taking screenshot (format: [scope::]milliseconds, e.g., \"1000\" or \"example.com::2000\")", "items": { "type": "string", "description": "Add delay in milliseconds before taking screenshot (format: [scope::]milliseconds, e.g., \"1000\" or \"example.com::2000\")" } }, "wait_for": { "type": "array", "description": "Wait for elements to appear before crawling (format: [scope::]type=value, e.g., \"CSS=#content\" or \"example.com::XPATH=//div[@class='loaded']\")", "items": { "type": "string", "description": "Wait for elements to appear before crawling (format: [scope::]type=value, e.g., \"CSS=#content\" or \"example.com::XPATH=//div[@class='loaded']\")" } }, "local_storage": { "type": "array", "description": "Set localStorage values used when visiting URLs (format: [scope::]key=value)", "items": { "type": "string", "description": "Set localStorage values used when visiting URLs (format: [scope::]key=value)" } }, "devices": { "type": "array", "description": "Device definitions (name, viewport, screen, devicePixelRatio, isMobile)", "items": { "$ref": "#/components/schemas/CrawlDeviceView" } }, "output_directory": { "type": "string", "description": "Output directory for crawl results. Default: \".\"" }, "cookies": { "type": "array", "description": "Set cookies used when visiting the URLs (format: [scope::]cookie_value, e.g., \"session=abc123\" or \"example.com::auth=token123; Path=/; Secure; HttpOnly\")", "items": { "type": "string", "description": "Set cookies used when visiting the URLs (format: [scope::]cookie_value, e.g., \"session=abc123\" or \"example.com::auth=token123; Path=/; Secure; HttpOnly\")" } }, "headers": { "type": "array", "description": "Set HTTP headers used when visiting the URLs (format: [scope::]name=value, e.g., \"Authorization=Bearer token\" or \"example.com::Accept=application/json\")", "items": { "type": "string", "description": "Set HTTP headers used when visiting the URLs (format: [scope::]name=value, e.g., \"Authorization=Bearer token\" or \"example.com::Accept=application/json\")" } } } }, "CreateSandboxActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "from": { "type": "string", "description": "The source type for creating the sandbox", "enum": [ "SCRATCH", "SANDBOX", "SNAPSHOT" ] }, "sandbox_identifier": { "type": "string", "description": "The identifier of the source sandbox (when creating from another sandbox)" }, "snapshot_name": { "type": "string", "description": "The name of the snapshot (when creating from a snapshot)" }, "update_if_exists": { "type": "boolean", "description": "Whether to update the sandbox configuration if a sandbox with the same identifier already exists in the project. If true and a sandbox exists, it will be reconfigured with the new specification instead of creating a new one" }, "start": { "type": "boolean", "description": "Whether to start the sandbox after creation" }, "spec": { "$ref": "#/components/schemas/SandboxView" } } }, "CustomActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "custom_type": { "type": "string", "description": "The type identifier of the custom action" }, "variables_access": { "type": "boolean", "description": "If set to `true`, the custom action has access to pipeline variables" }, "filesystem_access": { "type": "boolean", "description": "If set to `true`, the custom action has access to the pipeline filesystem" }, "inputs": { "type": "array", "description": "The list of input parameters for the custom action", "items": { "$ref": "#/components/schemas/InputView" } } } }, "CypressActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "working_directory": { "type": "string", "description": "The directory in which the pipeline filesystem will be mounted" }, "main_service_name": { "type": "string", "description": "The hostname of the container in which the action is run. The container will be available under this name in the docker network for services" }, "run_as_user": { "type": "string", "description": "All build commands are run as the default user defined in the selected Docker image. Can be set to another username (on the condition that this user exists in the selected image)" }, "version": { "type": "string", "description": "The version of the artifact from artifact registry" }, "docker_image_name": { "type": "string", "description": "The name of the Docker image" }, "docker_image_tag": { "type": "string", "description": "The tag of the Docker image" }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "mount_filesystem_disable": { "type": "boolean", "description": "If set to `true`, the filesystem will not be mounted in the container" }, "volume_mappings": { "type": "array", "description": "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)", "items": { "type": "string", "description": "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)" } }, "cached_dirs": { "type": "array", "description": "The dependencies & directories to be cached and available to every execution in this pipeline", "items": { "type": "string", "description": "The dependencies & directories to be cached and available to every execution in this pipeline" } }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "services": { "type": "array", "description": "The list of services attached to the build environment", "items": { "$ref": "#/components/schemas/ServiceView" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "registry": { "type": "string", "description": "The URL of the Docker registry" }, "insecure_registry": { "type": "boolean", "description": "If set to `true`, the registry will be accessed over HTTP instead of HTTPS" }, "login": { "type": "string", "description": "The username for the Docker registry" }, "target_stage": { "type": "string", "description": "The target stage of the Dockerfile" }, "password": { "type": "string", "description": "The password for the Docker registry" }, "region": { "type": "string", "description": "The region for the Docker registry (for AWS ECR)" }, "image_location": { "type": "string", "description": "The location of the image used by the action", "enum": [ "PUBLIC_REGISTRY", "PRIVATE_REGISTRY", "ACTION", "ARTIFACT_REGISTRY" ] }, "docker_registry": { "type": "string", "description": "The type of registry from which the image is retrieved", "enum": [ "NONE", "DOCKER_HUB", "AMAZON_ECR", "GOOGLE_GCR", "GOOGLE_ARTIFACT_REGISTRY", "OTHER", "GIT_HUB_CONTAINER_REGISTRY", "ARTIFACT_REGISTRY", "DIGITAL_OCEAN_CONTAINER_REGISTRY" ] }, "docker_build_action_id": { "type": "integer", "description": "The ID of the action from which the Docker image will be used", "format": "int32" }, "docker_build_action_name": { "type": "string", "description": "The name of the action from which the Docker image will be used" }, "export_container_path": { "type": "string", "description": "The path in the container to export" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "ignore_image_pull_failures": { "type": "boolean", "description": "If set to `true`, use cached image on timeouts (only for official images)" }, "cache_base_image": { "type": "boolean", "description": "If set to `true`, the cached version of the image is used, instead of being pulled each time" }, "reset_entrypoint": { "type": "boolean", "description": "If set to `true`, resets the default entrypoint set by the image. Default value: `false`" }, "vt_suite": { "type": "string", "description": "The visual tests suite identifier" }, "unit_tests_suite": { "type": "string", "description": "The unit tests suite identifier" }, "unit_tests_path": { "type": "string", "description": "The path to the unit tests results" }, "artifact": { "type": "string", "description": "The identifier of the artifact from artifact registry" } } }, "DatadogActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "content": { "type": "string", "description": "The content of the posted event" }, "title": { "type": "string", "description": "The title of the posted event" }, "host": { "type": "string", "description": "The Host name to associate with the event. Any tags associated with the host will also be applied to this event" }, "tags": { "uniqueItems": true, "type": "array", "description": "The list of tags to apply to the event", "items": { "type": "string", "description": "The list of tags to apply to the event" } }, "alert_type": { "type": "string", "description": "The type of the alert. Can be one of `SUCCESS`, `WARNING` or `ERROR`" }, "aggregation_key": { "type": "string", "description": "An arbitrary string to use for aggregation, max length of 100 characters. If you specify a key, all events using that key will be grouped together in the Event Stream" }, "region": { "type": "string", "description": "The Datadog region. Can be one of `US1`, `US3`, `US5`, `EU1`, `AP1`, `US1_FED`. If not set, the default is `US1`" } } }, "DatadogStatusCheckActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "message": { "type": "string", "description": "A description of why this status occurred" }, "check": { "type": "string", "description": "The text for the message" }, "host_name": { "type": "string", "description": "The Host name to associate with the event. Any tags associated with the host will also be applied to this event" }, "status": { "type": "integer", "description": "An integer for the status of the check", "format": "int32" }, "region": { "type": "string", "description": "The Datadog region. Can be one of `US1`, `US3`, `US5`, `EU1`, `AP1`, `US1_FED`. If not set, the default is `US1`" } } }, "DeployToSandboxActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "sandbox_id": { "type": "string", "description": "The ID of the sandbox" }, "sandbox_references": { "uniqueItems": true, "type": "array", "description": "The set of sandbox reference types", "items": { "type": "string", "description": "The set of sandbox reference types", "enum": [ "BY_ID", "BY_TAGS", "BY_ACTION", "BY_NAME", "BY_PROJECT", "BY_DAYS" ] } }, "sandbox_project_id": { "type": "integer", "description": "The ID of the sandbox project", "format": "int32" }, "sandbox_project_name": { "type": "string", "description": "The name of the sandbox project" }, "tags": { "uniqueItems": true, "type": "array", "description": "The set of tags for the sandbox", "items": { "type": "string", "description": "The set of tags for the sandbox" } }, "referenced_sandbox_name": { "type": "string", "description": "The name of the referenced sandbox" }, "days": { "type": "integer", "description": "The number of days for sandbox retention", "format": "int32" }, "referenced_action_id": { "type": "integer", "description": "The ID of the referenced action", "format": "int32" }, "referenced_action_name": { "type": "string", "description": "The name of the referenced action" }, "local_path": { "type": "string", "description": "The local path to the files to deploy" }, "remote_path": { "type": "string", "description": "The remote path in the sandbox where files will be deployed" }, "user": { "type": "string", "description": "The user account to use for deployment" }, "deployment_excludes": { "type": "array", "description": "The list of file patterns to exclude from deployment", "items": { "type": "string", "description": "The list of file patterns to exclude from deployment" } }, "deployment_includes": { "type": "array", "description": "The list of file patterns to include in deployment", "items": { "type": "string", "description": "The list of file patterns to include in deployment" } }, "input_type": { "type": "string", "description": "The type of input source (`SCM` or `BUILD_ARTIFACTS`)", "enum": [ "SCM_REPOSITORY", "BUILD_ARTIFACTS" ] }, "deletion_disabled": { "type": "boolean", "description": "If set to `true`, files in the target directory that don't exist in the source won't be deleted" }, "use_temporary_files": { "type": "boolean", "description": "If set to `true`, temporary files will be used during deployment" } } }, "DigitalOceanCdnInvalidationActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "purge_all": { "type": "boolean", "description": "If set to `true`, all cached content will be purged" }, "purge_by_change_set_limit": { "type": "integer", "description": "The maximum number of files in the changeset to trigger purge", "format": "int32" }, "local_path": { "type": "string", "description": "The path to the local files to invalidate" }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from cache invalidation", "items": { "type": "string", "description": "The list of files or directories to exclude from cache invalidation" } }, "deployment_includes": { "type": "array", "description": "The list of files or directories to include in cache invalidation", "items": { "type": "string", "description": "The list of files or directories to include in cache invalidation" } }, "paths": { "type": "array", "description": "The list of paths to invalidate", "items": { "type": "string", "description": "The list of paths to invalidate" } }, "input_type": { "type": "string", "description": "The type of source input for invalidation (`SCM` or `BUILD_ARTIFACTS`)", "enum": [ "SCM_REPOSITORY", "BUILD_ARTIFACTS" ] }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "endpoint": { "type": "string", "description": "The ID of the DigitalOcean CDN web distribution" }, "remote_path": { "type": "string", "description": "The path to invalidate in the CDN cache" } } }, "DiscordActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "notification_url": { "type": "string", "description": "The URL do the desired Discord [webhook](https://discordapp.com/developers/docs/resources/webhook#execute-webhook)" }, "content": { "type": "string", "description": "The content of the notification" }, "attachments": { "type": "array", "description": "The embedded rich content. More info [here](https://discordapp.com/developers/docs/resources/channel#attachment-object-attachment-structure)", "items": { "type": "string", "description": "The embedded rich content. More info [here](https://discordapp.com/developers/docs/resources/channel#attachment-object-attachment-structure)" } }, "file_attachments": { "type": "array", "description": "The attached files", "items": { "type": "string", "description": "The attached files" } } } }, "DoSpacesActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "local_path": { "type": "string", "description": "The path to the local files to deploy" }, "remote_path": { "type": "string", "description": "The path on the remote server where files will be deployed" }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "deployment_includes": { "type": "array", "description": "The list of files or directories to include in deployment", "items": { "type": "string", "description": "The list of files or directories to include in deployment" } }, "input_type": { "type": "string", "description": "The type of source input", "enum": [ "SCM_REPOSITORY", "BUILD_ARTIFACTS" ] }, "deletion_disabled": { "type": "boolean", "description": "If set to `true`, files on the remote server will not be deleted" }, "use_temporary_files": { "type": "boolean", "description": "If set to `true`, files will be uploaded to a temporary directory first" }, "content_encoding": { "type": "string", "description": "The content encoding for deployed files" }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "bucket_name": { "type": "string", "description": "The name of the DigitalOcean Spaces bucket" }, "public_access": { "type": "boolean", "description": "If set to `true`, uploaded files will have public read access" }, "cache_control": { "type": "string", "description": "The Cache-Control header value for uploaded files" }, "region": { "type": "string", "description": "The DigitalOcean Spaces region" } } }, "DockerBuildMultiArchActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "docker_image_tag": { "type": "string", "description": "The tag of the Docker image" }, "repository": { "type": "string", "description": "The name of the Docker repository" }, "registry": { "type": "string", "description": "The URL of the Docker registry" }, "insecure_registry": { "type": "boolean", "description": "If set to `true`, the registry will be accessed over HTTP instead of HTTPS" }, "region": { "type": "string", "description": "The region for the Docker registry (for AWS ECR)" }, "login": { "type": "string", "description": "The username for the Docker registry" }, "password": { "type": "string", "description": "The password for the Docker registry" }, "target_stage": { "type": "string", "description": "The target stage of the Dockerfile" }, "do_not_prune_images": { "type": "boolean", "description": "If set to `true`, images will not be pruned after the build" }, "versions": { "type": "array", "description": "The list of image versions to build or push", "items": { "type": "string", "description": "The list of image versions to build or push" } }, "docker_registry": { "type": "string", "description": "The type of registry from which the image is retrieved", "enum": [ "NONE", "DOCKER_HUB", "AMAZON_ECR", "GOOGLE_GCR", "GOOGLE_ARTIFACT_REGISTRY", "OTHER", "GIT_HUB_CONTAINER_REGISTRY", "ARTIFACT_REGISTRY", "DIGITAL_OCEAN_CONTAINER_REGISTRY" ] }, "target_platform": { "type": "string", "description": "The target platform for the Docker build" }, "cache_mode": { "type": "string", "description": "The caching mode for Docker build", "enum": [ "MIN", "MAX" ] }, "pull": { "type": "boolean", "description": "If set to `false`, the image will not be pulled before building" }, "dockerfile_path": { "type": "string", "description": "The path to the Dockerfile" }, "context_path": { "type": "string", "description": "The path to the Docker build context" }, "provenance": { "type": "string", "description": "The provenance attestation mode for the build", "enum": [ "NONE", "MIN", "MAX" ] }, "build_args": { "type": "array", "description": "The list of build arguments to pass to the Docker build", "items": { "type": "string", "description": "The list of build arguments to pass to the Docker build" } }, "secrets": { "type": "array", "description": "The list of secrets to pass to the Docker build", "items": { "$ref": "#/components/schemas/DockerSecretView" } }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "artifact": { "type": "string", "description": "The identifier of the artifact from artifact registry" } } }, "DockerCliActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "registry": { "type": "string", "description": "The Docker registry URL" }, "region": { "type": "string", "description": "The region for cloud-based Docker registries" }, "login": { "type": "string", "description": "The login username for Docker registry authentication" }, "password": { "type": "string", "description": "The password for Docker registry authentication" } } }, "DockerCliNativeBuildActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "working_directory": { "type": "string", "description": "The directory in which the pipeline filesystem will be mounted" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "commands": { "type": "array", "description": "The commands to execute in the native build environment", "items": { "type": "string", "description": "The commands to execute in the native build environment" } }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "vm_from_prev_action": { "type": "boolean", "description": "If set to `true`, the VM from the previous action will be used" }, "vm_action_id": { "type": "integer", "description": "The ID of the action from which the VM will be used", "format": "int32" }, "vm_action_name": { "type": "string", "description": "The name of the action from which the VM will be used" }, "instance_type": { "type": "string", "description": "The type of instance to use for the native build", "enum": [ "GENERAL_MEDIUM", "GENERAL_LARGE", "GENERAL_XLARGE", "GENERAL_2XLARGE", "COMPUTE_MEDIUM", "COMPUTE_LARGE", "COMPUTE_XLARGE", "COMPUTE_2XLARGE", "ARM_GENERAL_MEDIUM", "ARM_GENERAL_LARGE", "ARM_GENERAL_XLARGE", "ARM_GENERAL_2XLARGE", "ARM_COMPUTE_MEDIUM", "ARM_COMPUTE_LARGE", "ARM_COMPUTE_XLARGE", "ARM_COMPUTE_2XLARGE" ] }, "sync_paths": { "type": "array", "description": "File paths that should be copied before (`PIPELINE_TO_VM`) and after the execution (`VM_TO_PIPELINE`)", "items": { "$ref": "#/components/schemas/SyncPathView" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "distribution": { "type": "string", "description": "The AWS distribution type for the Docker native build", "enum": [ "UBUNTU_20_04", "AMI", "WINDOWS_SERVER_2019", "PREVIOUS_ACTION" ] }, "ami": { "$ref": "#/components/schemas/AmiView" } } }, "DockerPushActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "docker_image_tag": { "type": "string", "description": "The tag of the Docker image" }, "repository": { "type": "string", "description": "The name of the Docker repository" }, "registry": { "type": "string", "description": "The URL of the Docker registry" }, "insecure_registry": { "type": "boolean", "description": "If set to `true`, the registry will be accessed over HTTP instead of HTTPS" }, "region": { "type": "string", "description": "The region for the Docker registry (for AWS ECR)" }, "login": { "type": "string", "description": "The username for the Docker registry" }, "password": { "type": "string", "description": "The password for the Docker registry" }, "target_stage": { "type": "string", "description": "The target stage of the Dockerfile" }, "do_not_prune_images": { "type": "boolean", "description": "If set to `true`, images will not be pruned after the build" }, "versions": { "type": "array", "description": "The list of image versions to build or push", "items": { "type": "string", "description": "The list of image versions to build or push" } }, "docker_registry": { "type": "string", "description": "The type of registry from which the image is retrieved", "enum": [ "NONE", "DOCKER_HUB", "AMAZON_ECR", "GOOGLE_GCR", "GOOGLE_ARTIFACT_REGISTRY", "OTHER", "GIT_HUB_CONTAINER_REGISTRY", "ARTIFACT_REGISTRY", "DIGITAL_OCEAN_CONTAINER_REGISTRY" ] }, "target_platform": { "type": "string", "description": "The target platform for the Docker build" }, "cache_mode": { "type": "string", "description": "The caching mode for Docker build", "enum": [ "MIN", "MAX" ] }, "pull": { "type": "boolean", "description": "If set to `false`, the image will not be pulled before building" }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "docker_build_action_id": { "type": "integer", "description": "The ID of the action from which the Docker image will be used", "format": "int32" }, "docker_build_action_name": { "type": "string", "description": "The name of the action from which the Docker image will be used" }, "artifact": { "type": "string", "description": "The identifier of the artifact from artifact registry" } } }, "DockerfileActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "docker_image_tag": { "type": "string", "description": "The tag of the Docker image" }, "repository": { "type": "string", "description": "The name of the Docker repository" }, "registry": { "type": "string", "description": "The URL of the Docker registry" }, "insecure_registry": { "type": "boolean", "description": "If set to `true`, the registry will be accessed over HTTP instead of HTTPS" }, "region": { "type": "string", "description": "The region for the Docker registry (for AWS ECR)" }, "login": { "type": "string", "description": "The username for the Docker registry" }, "password": { "type": "string", "description": "The password for the Docker registry" }, "target_stage": { "type": "string", "description": "The target stage of the Dockerfile" }, "do_not_prune_images": { "type": "boolean", "description": "If set to `true`, images will not be pruned after the build" }, "versions": { "type": "array", "description": "The list of image versions to build or push", "items": { "type": "string", "description": "The list of image versions to build or push" } }, "docker_registry": { "type": "string", "description": "The type of registry from which the image is retrieved", "enum": [ "NONE", "DOCKER_HUB", "AMAZON_ECR", "GOOGLE_GCR", "GOOGLE_ARTIFACT_REGISTRY", "OTHER", "GIT_HUB_CONTAINER_REGISTRY", "ARTIFACT_REGISTRY", "DIGITAL_OCEAN_CONTAINER_REGISTRY" ] }, "target_platform": { "type": "string", "description": "The target platform for the Docker build" }, "cache_mode": { "type": "string", "description": "The caching mode for Docker build", "enum": [ "MIN", "MAX" ] }, "pull": { "type": "boolean", "description": "If set to `false`, the image will not be pulled before building" }, "dockerfile_path": { "type": "string", "description": "The path to the Dockerfile" }, "context_path": { "type": "string", "description": "The path to the Docker build context" }, "provenance": { "type": "string", "description": "The provenance attestation mode for the build", "enum": [ "NONE", "MIN", "MAX" ] }, "build_args": { "type": "array", "description": "The list of build arguments to pass to the Docker build", "items": { "type": "string", "description": "The list of build arguments to pass to the Docker build" } }, "secrets": { "type": "array", "description": "The list of secrets to pass to the Docker build", "items": { "$ref": "#/components/schemas/DockerSecretView" } }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "artifact": { "type": "string", "description": "The identifier of the artifact from artifact registry" } } }, "DockerfileLinterActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "local_path": { "type": "string", "description": "The path to the Dockerfile to lint" }, "shell_type": { "type": "string", "description": "The shell type to use for linting (e.g., `bash`, `sh`)" }, "ignore_codes": { "type": "string", "description": "Comma-separated list of rule codes to ignore during linting" }, "ignores_path": { "type": "string", "description": "The path to a file containing rules to ignore" } } }, "DoctlActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" } } }, "DownloadArtifactActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "source_path": { "type": "string", "description": "The path to the source file or directory to download" }, "destination_path": { "type": "string", "description": "The path where the downloaded files will be saved" }, "recursive": { "type": "boolean", "description": "If set to `true`, directories will be downloaded recursively" }, "overwrite": { "type": "boolean", "description": "If set to `true`, existing files will be overwritten" }, "download_excludes": { "type": "array", "description": "The list of files or directories to exclude from download", "items": { "type": "string", "description": "The list of files or directories to exclude from download" } }, "download_includes": { "type": "array", "description": "The list of files or directories to include in download", "items": { "type": "string", "description": "The list of files or directories to include in download" } }, "version": { "type": "string", "description": "The version of the artifact from artifact registry" }, "artifact": { "type": "string", "description": "The identifier of the artifact from artifact registry" } } }, "DownloadBackblazeActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "source_path": { "type": "string", "description": "The path to the source file or directory to download" }, "destination_path": { "type": "string", "description": "The path where the downloaded files will be saved" }, "recursive": { "type": "boolean", "description": "If set to `true`, directories will be downloaded recursively" }, "overwrite": { "type": "boolean", "description": "If set to `true`, existing files will be overwritten" }, "download_excludes": { "type": "array", "description": "The list of files or directories to exclude from download", "items": { "type": "string", "description": "The list of files or directories to exclude from download" } }, "download_includes": { "type": "array", "description": "The list of files or directories to include in download", "items": { "type": "string", "description": "The list of files or directories to include in download" } }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "bucket_name": { "type": "string", "description": "The name of the Backblaze B2 bucket" }, "region": { "type": "string", "description": "The Backblaze B2 region" } } }, "DownloadFromGcsActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "source_path": { "type": "string", "description": "The path to the source file or directory to download" }, "destination_path": { "type": "string", "description": "The path where the downloaded files will be saved" }, "recursive": { "type": "boolean", "description": "If set to `true`, directories will be downloaded recursively" }, "overwrite": { "type": "boolean", "description": "If set to `true`, existing files will be overwritten" }, "download_excludes": { "type": "array", "description": "The list of files or directories to exclude from download", "items": { "type": "string", "description": "The list of files or directories to exclude from download" } }, "download_includes": { "type": "array", "description": "The list of files or directories to include in download", "items": { "type": "string", "description": "The list of files or directories to include in download" } }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "bucket_name": { "type": "string", "description": "The name of the Google Cloud Storage bucket to download from" }, "application_name": { "type": "string", "description": "The name of the GCS application" } } }, "DownloadFromSandboxActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "source_path": { "type": "string", "description": "The path to the source file or directory to download" }, "destination_path": { "type": "string", "description": "The path where the downloaded files will be saved" }, "recursive": { "type": "boolean", "description": "If set to `true`, directories will be downloaded recursively" }, "overwrite": { "type": "boolean", "description": "If set to `true`, existing files will be overwritten" }, "download_excludes": { "type": "array", "description": "The list of files or directories to exclude from download", "items": { "type": "string", "description": "The list of files or directories to exclude from download" } }, "download_includes": { "type": "array", "description": "The list of files or directories to include in download", "items": { "type": "string", "description": "The list of files or directories to include in download" } }, "sandbox_references": { "uniqueItems": true, "type": "array", "description": "The set of sandbox reference types", "items": { "type": "string", "description": "The set of sandbox reference types", "enum": [ "BY_ID", "BY_TAGS", "BY_ACTION", "BY_NAME", "BY_PROJECT", "BY_DAYS" ] } }, "sandbox_id": { "type": "string", "description": "The ID of the sandbox" }, "sandbox_project_id": { "type": "integer", "description": "The ID of the sandbox project", "format": "int32" }, "sandbox_project_name": { "type": "string", "description": "The name of the sandbox project" }, "user": { "type": "string", "description": "The user account to use for download operations" } } }, "DownloadFtpActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "source_path": { "type": "string", "description": "The path to the source file or directory to download" }, "destination_path": { "type": "string", "description": "The path where the downloaded files will be saved" }, "recursive": { "type": "boolean", "description": "If set to `true`, directories will be downloaded recursively" }, "overwrite": { "type": "boolean", "description": "If set to `true`, existing files will be overwritten" }, "download_excludes": { "type": "array", "description": "The list of files or directories to exclude from download", "items": { "type": "string", "description": "The list of files or directories to exclude from download" } }, "download_includes": { "type": "array", "description": "The list of files or directories to include in download", "items": { "type": "string", "description": "The list of files or directories to include in download" } }, "targets": { "type": "array", "description": "The list of FTP server targets", "items": { "$ref": "#/components/schemas/TargetView" } } } }, "DownloadS3ActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "source_path": { "type": "string", "description": "The path to the source file or directory to download" }, "destination_path": { "type": "string", "description": "The path where the downloaded files will be saved" }, "recursive": { "type": "boolean", "description": "If set to `true`, directories will be downloaded recursively" }, "overwrite": { "type": "boolean", "description": "If set to `true`, existing files will be overwritten" }, "download_excludes": { "type": "array", "description": "The list of files or directories to exclude from download", "items": { "type": "string", "description": "The list of files or directories to exclude from download" } }, "download_includes": { "type": "array", "description": "The list of files or directories to include in download", "items": { "type": "string", "description": "The list of files or directories to include in download" } }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "bucket_name": { "type": "string", "description": "The name of the Amazon S3 Bucket" } } }, "EmailActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "title": { "type": "string", "description": "The title of the notification" }, "content": { "type": "string", "description": "The content of the notification" }, "recipients": { "type": "string", "description": "The recipients of the notification: email addresses (one per line). One of `send_to_groups` or `recipients` must be specified" }, "send_to_groups": { "type": "array", "description": "The list of groups' names to which emails will be sent. One of `send_to_groups` or `recipients` must be specified", "items": { "type": "string", "description": "The list of groups' names to which emails will be sent. One of `send_to_groups` or `recipients` must be specified" } }, "send_as_html": { "type": "boolean", "description": "Defines whether to send the content as HTML" }, "from_name": { "type": "string", "description": "The e-mail sender name" }, "file_attachments": { "type": "array", "description": "The attached files", "items": { "type": "string", "description": "The attached files" } } } }, "EslintActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "local_path": { "type": "string", "description": "The path in the repository" }, "style": { "type": "string", "description": "The name of the code style. Can be one of `airbnb`, `canonical`, `canonical/ava`, `canonical/flowtype`, `canonical/jest`, `canonical/lodash`, `canonical/mocha`, `canonical/react`, `eslint`, `es/2015/server`, `es/2015/client`, `facebook`, `google`, `standard`, `xo`, `xo/esnext`, `xo/browser` or `custom`" }, "version": { "type": "string", "description": "The version of the NodeJS" }, "build_tool_version": { "type": "string", "description": "The version of the build tools" }, "fix": { "type": "boolean", "description": "Defines whether to automatically fix code issues or just perform the code analysis" }, "quiet": { "type": "boolean", "description": "When set to `true`, reports only errors, without warnings" }, "config_path": { "type": "string", "description": "Required if `style` is set to `custom`. Path to the style config file" } } }, "FastlaneAndroidActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "build_tool_version": { "type": "string", "description": "The version of the Android Build Tools" } } }, "FirebaseActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "working_directory": { "type": "string", "description": "The directory in which the commands are executed. Available when `type` is set to `CUSTOM`" }, "mount_filesystem_disable": { "type": "boolean", "description": "Defines whether or not to mount the filesystem to the running container" }, "volume_mappings": { "type": "array", "description": "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)", "items": { "type": "string", "description": "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)" } }, "execute_commands": { "type": "array", "description": "Commands that will be executed", "items": { "type": "string", "description": "Commands that will be executed" } }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "application_id": { "type": "string", "description": "The ID of the Firebase application" }, "build_tool_version": { "type": "string", "description": "The version of the build tools" }, "version": { "type": "string", "description": "The version of the Firebase CLI" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" } } }, "GcsActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "local_path": { "type": "string", "description": "The path to the local files to deploy" }, "remote_path": { "type": "string", "description": "The path on the remote server where files will be deployed" }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "deployment_includes": { "type": "array", "description": "The list of files or directories to include in deployment", "items": { "type": "string", "description": "The list of files or directories to include in deployment" } }, "input_type": { "type": "string", "description": "The type of source input", "enum": [ "SCM_REPOSITORY", "BUILD_ARTIFACTS" ] }, "deletion_disabled": { "type": "boolean", "description": "If set to `true`, files on the remote server will not be deleted" }, "use_temporary_files": { "type": "boolean", "description": "If set to `true`, files will be uploaded to a temporary directory first" }, "content_encoding": { "type": "string", "description": "The content encoding for deployed files" }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "application_name": { "type": "string", "description": "The name of the GCS application" }, "bucket_name": { "type": "string", "description": "The name of the GCS Bucket" }, "public_access": { "type": "boolean", "description": "Makes files accessible through public HTTP" }, "cache_control": { "type": "string", "description": "Specifies how long objects stay in the cache" } } }, "GhostInspectorActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "api_key": { "type": "string", "description": "The API key for Ghost Inspector" }, "region": { "type": "string", "description": "Geo-location for test execution. The following options are available: `us-east-1`, `us-west-1`, `ca-central-1`, `eu-central-1`, `eu-west-1`, `eu-west-2`, `eu-west-3`, `eu-north-1`, `ap-northeast-1`, `ap-northeast-2`, `ap-southeast-1`, `ap-southeast-2`, `ap-south-1`, `sa-east-1`" }, "folder": { "type": "string", "description": "The ID of the folder to execute" }, "suite": { "type": "string", "description": "The ID of the suite to execute" }, "browser": { "type": "string", "description": "Alternate browser to use for this execution. The following options are available: `firefox` (default), `firefox-` specific version of Firefox, for example `firefox-57`, `chrome` (paid plans only), `phantomjs`" }, "channel": { "type": "string", "description": "Specify the Slack channel to notify for this suite run. Note that the value must be `myChannel` or `%23myChannel` and not `#myChannel`" }, "user": { "type": "string", "description": "The name to associate with the event" }, "password": { "type": "string", "description": "The password to associate with the event" }, "immediate": { "type": "boolean", "description": "Use to initiate the execution, then immediate return a response (without results)" }, "disable_notification": { "type": "boolean", "description": "Use to disable all notifications for this execution only" }, "start_url": { "type": "string", "description": "Alternate start URL to use for all tests in this execution only" }, "user_agent": { "type": "string", "description": "Alternate user agent to use for all tests in this execution only" }, "webhook": { "type": "string", "description": "The webhook URL to call after execution" }, "viewport": { "type": "string", "description": "Alternate screen size to use for all tests in this execution only. This should be a string formatted as `{width}x{height}`, for example `1024x768`" }, "data_file": { "type": "string", "description": "A CSV file containing a row of variable values for each suite run. A POST request must be used when sending this file. When included, an array of suite results will be returned instead of an array of test result" } } }, "GhostInspectorCliActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" } } }, "GitCryptActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "force_arg": { "type": "boolean", "description": "Set to `true` if you want to lock even if there is uncommitted work in pipeline filesystem" }, "keys": { "type": "array", "description": "Key names you want to use to lock your repository", "items": { "$ref": "#/components/schemas/BinaryFileView" } } } }, "GitHubCliActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" } } }, "GitHubReleaseActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "tag_name": { "type": "string", "description": "The name of the tag" }, "target_commitish": { "type": "string", "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch" }, "release_name": { "type": "string", "description": "The name of the release" }, "body": { "type": "string", "description": "Text describing the contents of the tag" }, "draft": { "type": "boolean", "description": "Set to `true` to create a draft (unpublished) release or to `false` to create a published one. By default, it's set to `false`" }, "prerelease": { "type": "boolean", "description": "Set to `true` to identify the release as a prerelease. Set to `false` to identify the release as a full release. By default, it's set to `false`" }, "zip_assets": { "type": "boolean", "description": "Set to `true` to zip assets for release. By default, it's set to `true`" }, "repository": { "type": "string", "description": "The name of the repository" }, "organization": { "type": "string", "description": "The account owner of the repository. The name is not case-sensitive" }, "assets": { "type": "array", "description": "The artifact of assets for this release. The path has to be provided in the `source_path` field and the label name in the `label` field", "items": { "$ref": "#/components/schemas/GitHubReleaseAssetReference" } } } }, "GitLabCliActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" } } }, "GitMergeActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "branch": { "type": "string", "description": "The source branch to merge into the current branch" }, "conflict_strategy": { "type": "string", "description": "The strategy for handling merge conflicts: `FAIL` (default), `OURS`, or `THEIRS`", "enum": [ "FAIL", "OURS", "THEIRS" ] }, "dry_run": { "type": "boolean", "description": "Set to `true` to only check if the merge is possible without actually performing it" }, "no_fast_forward": { "type": "boolean", "description": "Set to `true` to always create a merge commit even if a fast-forward merge is possible" }, "commiter_email": { "type": "string", "description": "The email address of the committer used in the merge commit" }, "commit_message": { "type": "string", "description": "The custom commit message for the merge commit" } } }, "GoogleAppDeployActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "local_path": { "type": "string", "description": "The path to the local application files" }, "config_path": { "type": "string", "description": "The path to the configuration file" }, "application_name": { "type": "string", "description": "The name of the Google App Engine application" }, "bucket_name": { "type": "string", "description": "The name of the Google Cloud Storage bucket" }, "version_label": { "type": "string", "description": "The version label for the deployment" }, "image_url": { "type": "string", "description": "The URL of the Docker image" }, "promote_all_traffic": { "type": "boolean", "description": "If set to `true`, all traffic will be promoted to the new version" }, "stop_previous_version": { "type": "boolean", "description": "If set to `true`, the previous version will be stopped" }, "verbosity": { "type": "string", "description": "The verbosity level for deployment logging" }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" } } }, "GoogleAppEngineActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "local_path": { "type": "string", "description": "The path to the local application files" }, "config_path": { "type": "string", "description": "The path to the configuration file" }, "application_name": { "type": "string", "description": "The name of the Google App Engine application" }, "bucket_name": { "type": "string", "description": "The name of the Google Cloud Storage bucket" }, "version_label": { "type": "string", "description": "The version label for the deployment" }, "image_url": { "type": "string", "description": "The URL of the Docker image" }, "promote_all_traffic": { "type": "boolean", "description": "If set to `true`, all traffic will be promoted to the new version" }, "stop_previous_version": { "type": "boolean", "description": "If set to `true`, the previous version will be stopped" }, "verbosity": { "type": "string", "description": "The verbosity level for deployment logging" }, "server_key": { "type": "string", "description": "The private SSH key" }, "env_key": { "type": "string", "description": "The private SSH key name defined in environment variables" } } }, "GoogleCdnInvalidationActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "purge_all": { "type": "boolean", "description": "If set to `true`, all cached content will be purged" }, "purge_by_change_set_limit": { "type": "integer", "description": "The maximum number of files in the changeset to trigger purge", "format": "int32" }, "local_path": { "type": "string", "description": "The path to the local files to invalidate" }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from cache invalidation", "items": { "type": "string", "description": "The list of files or directories to exclude from cache invalidation" } }, "deployment_includes": { "type": "array", "description": "The list of files or directories to include in cache invalidation", "items": { "type": "string", "description": "The list of files or directories to include in cache invalidation" } }, "paths": { "type": "array", "description": "The list of paths to invalidate", "items": { "type": "string", "description": "The list of paths to invalidate" } }, "input_type": { "type": "string", "description": "The type of source input for invalidation (`SCM` or `BUILD_ARTIFACTS`)", "enum": [ "SCM_REPOSITORY", "BUILD_ARTIFACTS" ] }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "distribution_id": { "type": "string", "description": "The ID of the Google web distribution" }, "url_map": { "type": "string", "description": "The name of the mapping rules" }, "remote_path": { "type": "string", "description": "The absolute or relative path on the remote server" } } }, "GoogleChatActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "content": { "type": "string", "description": "The content of the notification" }, "channel": { "type": "string", "description": "The ID of the Google Chat channel" } } }, "GoogleCloudCliActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "application_name": { "type": "string", "description": "The name of the Google application" }, "server_key": { "type": "string", "description": "The private SSH key" }, "env_key": { "type": "string", "description": "The private SSH key name defined in environment variables" }, "version": { "type": "string", "description": "The version of Google Cloud CLI to use. Defaults to `latest`" } } }, "GoogleCloudRunDeployActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "application_name": { "type": "string", "description": "The name of the application" }, "server_key": { "type": "string", "description": "The private SSH key" }, "env_key": { "type": "string", "description": "The private SSH key name defined in environment variables" }, "arguments": { "type": "string", "description": "Additional arguments for the deployment command" }, "service": { "type": "string", "description": "The name of the service" }, "image": { "type": "string", "description": "The name of the image" }, "platform": { "type": "string", "description": "Target platform for running commands", "enum": [ "MANAGED", "GKE", "KUBERNETES" ] }, "region": { "type": "string", "description": "The [region](https://cloud.google.com/compute/docs/regions-zones) in which the resource can be found. Required when platform is set to `MANAGED`" }, "config_path": { "type": "string", "description": "Kubectl configuration file. Required when the platform is set to `KUBERNETES`" }, "cluster": { "type": "string", "description": "The ID of the cluster or fully qualified identifier for the cluster. Required when the platform is set to `GKE`" }, "cluster_location": { "type": "string", "description": "The zone in which the cluster is located. Required when the platform is set to `GKE`" }, "context": { "type": "string", "description": "The name of the context in your kubectl config file to use for connecting. Required when the platform is set to `KUBERNETES`" } } }, "GoogleFunctionDeployActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "local_path": { "type": "string", "description": "The path in the repository" }, "function_name": { "type": "string", "description": "The name of the Google function" }, "runtime": { "type": "string", "description": "The Cloud Functions execution environment. Options: `nodejs6`, `nodejs8`, `nodejs10`, `nodejs12`, `python37`, `go111`" }, "command_args": { "type": "string", "description": "Additional arguments sent upon deploying the function" }, "application_id": { "type": "string", "description": "The id of the Google Cloud project" }, "region": { "type": "string", "description": "Region in which function can be found or will be created" }, "server_key": { "type": "string", "description": "The private SSH key" } } }, "GoogleFunctionInvokeActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "function_name": { "type": "string", "description": "The name of the function to invoke" }, "region": { "type": "string", "description": "The region where the function is located" }, "payload": { "type": "string", "description": "The payload to send to the function" }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "application_id": { "type": "string", "description": "The id of the Google Cloud project" } } }, "HelmActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "config_path": { "type": "string", "description": "The path to the Kubernetes configuration file" }, "kubectl_version": { "type": "string", "description": "The version of kubectl to use" }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "targets": { "type": "array", "description": "The list of Kubernetes cluster targets", "items": { "$ref": "#/components/schemas/TargetView" } }, "namespace": { "type": "string", "description": "The Kubernetes namespace" }, "content": { "type": "string", "description": "The content of the Kubernetes configuration" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "execute_commands": { "type": "array", "description": "Commands that will be executed", "items": { "type": "string", "description": "Commands that will be executed" } }, "helm_version": { "type": "string", "description": "The Helm version" }, "helm_repository_key": { "type": "string", "description": "Service Account Key from Google Cloud Storage. Set it if Helm repository is on GCS" }, "helm_repository_region": { "type": "string", "description": "Helm repository region. Set it if Helm repository is on AWS S3" }, "helm_repository_integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" } } }, "HerokuActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "push_tags": { "type": "boolean", "description": "If set to `true`, tags will be pushed to the repository" }, "push_only_tags": { "type": "boolean", "description": "If set to `true`, only tags will be pushed without commits" }, "target_branch": { "type": "string", "description": "The target branch to push to" }, "without_force": { "type": "boolean", "description": "If set to `true`, force push will not be used" }, "isolated": { "type": "boolean", "description": "If set to `true`, the action will run in an isolated environment" }, "use_custom_gitignore": { "type": "boolean", "description": "If set to `true`, custom .gitignore rules will be used" }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "comment": { "type": "string", "description": "The commit message for the push" }, "tag": { "type": "string", "description": "The tag name to create and push" }, "custom_options": { "type": "string", "description": "Custom git push options" }, "targets": { "type": "array", "description": "The list of target repositories to push to", "items": { "$ref": "#/components/schemas/TargetView" } }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "application_name": { "type": "string", "description": "The name of the application" } } }, "HerokuCliActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "region": { "type": "string", "description": "The region where the application is deployed" }, "application_name": { "type": "string", "description": "The name of the application" } } }, "HoneybadgerActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "project": { "type": "string", "description": "The project identifier" }, "token": { "type": "string", "description": "The Honeybadger token." }, "environment": { "type": "string", "description": "The Honeybadger environment." } } }, "HttpActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "content": { "type": "string", "description": "The content of the request." }, "method": { "type": "string", "description": "The desired HTTP method", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] }, "headers": { "type": "array", "description": "The headers that will be sent with the request.", "items": { "$ref": "#/components/schemas/HeaderView" } }, "login": { "type": "string", "description": "The username required to connect to the server." }, "notification_url": { "type": "string", "description": "The target URL." }, "port": { "type": "string", "description": "The port for the connection." }, "password": { "type": "string", "description": "The password required to connect to the server." }, "paths": { "type": "array", "description": "The list of paths for the request", "items": { "type": "string", "description": "The list of paths for the request" } }, "multipart_upload": { "type": "boolean", "description": "Enables multipart upload for the request" } } }, "ImageCompressionActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "local_path": { "type": "string", "description": "The path in the repository." }, "destination": { "type": "string", "description": "Output directory for compressed images." }, "level": { "type": "string", "description": "The level of image compression. Can be set to `1` (low), `2` (medium) or `3` (high)." }, "types": { "type": "string", "description": "Supported image formats. Available types: `jpg`, `png`, `gif`, `svg`." } } }, "IntegrationIdentifierView": { "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" } }, "description": "The integration used by the action" }, "IntegrationVariablesActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "integration_from": { "type": "string", "description": "Defines the source from which integration will be used to generate variables", "enum": [ "ACTION", "PROJECT" ] } } }, "JiraBuildActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "issueKey": { "type": "string", "description": "Jira issue key (e.g., PROJ-123)" }, "build_number": { "type": "string", "description": "Build number" }, "display_name": { "type": "string", "description": "Display name for the build" }, "description": { "type": "string", "description": "Description of the build" }, "state": { "type": "string", "description": "Build state (pending, in_progress, successful, failed, cancelled, unknown)" } } }, "JiraDeploymentActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "issueKey": { "type": "string", "description": "Jira issue key (e.g., PROJ-123)" }, "display_name": { "type": "string", "description": "Display name for the deployment" }, "description": { "type": "string", "description": "Description of the deployment" }, "state": { "type": "string", "description": "Deployment state (pending, in_progress, successful, failed, cancelled, rolled_back, unknown)" }, "environment_id": { "type": "string", "description": "Environment ID" }, "environment_name": { "type": "string", "description": "Environment name" }, "environment_type": { "type": "string", "description": "Environment type (unmapped, development, testing, staging, production)" } } }, "JmeterActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" } } }, "KubernetesApplyActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "config_path": { "type": "string", "description": "The path to the Kubernetes configuration file" }, "kubectl_version": { "type": "string", "description": "The version of kubectl to use" }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "targets": { "type": "array", "description": "The list of Kubernetes cluster targets", "items": { "$ref": "#/components/schemas/TargetView" } }, "namespace": { "type": "string", "description": "The Kubernetes namespace" }, "content": { "type": "string", "description": "The content of the Kubernetes configuration" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "record_arg": { "type": "string", "description": "Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists", "enum": [ "TRUE", "FALSE", "NOT_SET" ] }, "save_config_arg": { "type": "boolean", "description": "If `true`, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future." }, "overwrite_arg": { "type": "boolean", "description": "Automatically resolve conflicts between the modified and live configuration by using values from the modified configuration." }, "cascade_arg": { "type": "boolean", "description": "Only relevant during a prune or a force apply. If `true`, cascade the deletion of the resources managed by pruned or deleted resources (e.g. Pods created by a ReplicationController)." }, "cascade": { "type": "string", "description": "Defines cascade deletion behavior for resources", "enum": [ "BACKGROUND", "ORPHAN", "FOREGROUND" ] }, "all_arg": { "type": "boolean", "description": "Defines whether to select all the specified resources." }, "grace_period_arg": { "type": "integer", "description": "Only relevant during a prune or a force apply. Period of time in seconds given to pruned or deleted resources to terminate gracefully. Ignored if negative.", "format": "int32" }, "prune_arg": { "type": "boolean", "description": "Automatically delete resource objects that do not appear in the configs and are created by either apply or create –save-config. Should be used with either -l or –all." }, "prune_whitelist_arg": { "type": "string", "description": "Overwrite the default whitelist with `` for –prune." }, "force_arg": { "type": "boolean", "description": "Delete and re-create the specified resource, when PATCH encounters conflict and has retried for 5 times." }, "validate": { "type": "boolean", "description": "Validates the configuration before applying" } } }, "KubernetesCliActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "config_path": { "type": "string", "description": "The path to the Kubernetes configuration file" }, "kubectl_version": { "type": "string", "description": "The version of kubectl to use" }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "targets": { "type": "array", "description": "The list of Kubernetes cluster targets", "items": { "$ref": "#/components/schemas/TargetView" } }, "namespace": { "type": "string", "description": "The Kubernetes namespace" }, "content": { "type": "string", "description": "The content of the Kubernetes configuration" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "execute_commands": { "type": "array", "description": "The commands that will be executed.", "items": { "type": "string", "description": "The commands that will be executed." } }, "helm_version": { "type": "string", "description": "The Helm version" } } }, "KubernetesRunJobActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "config_path": { "type": "string", "description": "The path to the Kubernetes configuration file" }, "kubectl_version": { "type": "string", "description": "The version of kubectl to use" }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "targets": { "type": "array", "description": "The list of Kubernetes cluster targets", "items": { "$ref": "#/components/schemas/TargetView" } }, "namespace": { "type": "string", "description": "The Kubernetes namespace" }, "content": { "type": "string", "description": "The content of the Kubernetes configuration" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "leave_after": { "type": "boolean", "description": "If set to `true`, resources will be left after the action completes" }, "not_wait": { "type": "boolean", "description": "If set to `true`, the action will not wait for resources to be ready" }, "record_arg": { "type": "string", "description": "The record argument for the Kubernetes command", "enum": [ "TRUE", "FALSE", "NOT_SET" ] }, "save_config_arg": { "type": "boolean", "description": "If set to `true`, the configuration will be saved in the resource annotation" } } }, "KubernetesRunPodActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "config_path": { "type": "string", "description": "The path to the Kubernetes configuration file" }, "kubectl_version": { "type": "string", "description": "The version of kubectl to use" }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "targets": { "type": "array", "description": "The list of Kubernetes cluster targets", "items": { "$ref": "#/components/schemas/TargetView" } }, "namespace": { "type": "string", "description": "The Kubernetes namespace" }, "content": { "type": "string", "description": "The content of the Kubernetes configuration" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "leave_after": { "type": "boolean", "description": "If set to `true`, resources will be left after the action completes" }, "not_wait": { "type": "boolean", "description": "If set to `true`, the action will not wait for resources to be ready" }, "record_arg": { "type": "string", "description": "The record argument for the Kubernetes command", "enum": [ "TRUE", "FALSE", "NOT_SET" ] }, "save_config_arg": { "type": "boolean", "description": "If set to `true`, the configuration will be saved in the resource annotation" } } }, "KubernetesSetImageActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "config_path": { "type": "string", "description": "The path to the Kubernetes configuration file" }, "kubectl_version": { "type": "string", "description": "The version of kubectl to use" }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "targets": { "type": "array", "description": "The list of Kubernetes cluster targets", "items": { "$ref": "#/components/schemas/TargetView" } }, "namespace": { "type": "string", "description": "The Kubernetes namespace" }, "content": { "type": "string", "description": "The content of the Kubernetes configuration" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "deployment": { "type": "string", "description": "The name of the deployment from the namespace." }, "container": { "type": "string", "description": "The name of the container." }, "image_name": { "type": "string", "description": "The name of the image to set." }, "image_tag": { "type": "string", "description": "The tag of the chosen image." }, "record_arg": { "type": "string", "description": "Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists", "enum": [ "TRUE", "FALSE", "NOT_SET" ] } } }, "LighthouseActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "website": { "type": "string", "description": "The address of the site on which the audit should run" }, "device": { "type": "string", "description": "The device on which the audit will be run" }, "max_results": { "type": "integer", "description": "The maximum number of results to store", "format": "int32" }, "performance": { "type": "integer", "description": "Values from 0 to 100 are accepted. The action returns an error if the score is below the values that are set", "format": "int32" }, "accessibility": { "type": "integer", "description": "Values from 0 to 100 are accepted. The action returns an error if the score is below the values that are set", "format": "int32" }, "best_practices": { "type": "integer", "description": "Values from 0 to 100 are accepted. The action returns an error if the score is below the values that are set", "format": "int32" }, "seo": { "type": "integer", "description": "Values from 0 to 100 are accepted. The action returns an error if the score is below the values that are set", "format": "int32" }, "first_contentful_paint": { "type": "number", "description": "The maximum First Contentful Paint metric threshold", "format": "float" }, "first_meaningful_paint": { "type": "number", "description": "The maximum First Meaningful Paint metric threshold", "format": "float" }, "speed_index": { "type": "number", "description": "The maximum Speed Index metric threshold", "format": "float" }, "estimated_input_latency": { "type": "number", "description": "The maximum Estimated Input Latency metric threshold", "format": "float" }, "total_blocking_time": { "type": "number", "description": "The maximum Total Blocking Time metric threshold", "format": "float" }, "max_potential_fid": { "type": "number", "description": "The maximum Max Potential First Input Delay metric threshold", "format": "float" }, "time_to_first_byte": { "type": "number", "description": "The maximum Time to First Byte metric threshold", "format": "float" }, "first_cpu_idle": { "type": "number", "description": "The maximum First CPU Idle metric threshold", "format": "float" }, "bootup_time": { "type": "number", "description": "The maximum JavaScript bootup time metric threshold", "format": "float" }, "network_server_latency": { "type": "number", "description": "The maximum network server latency metric threshold", "format": "float" }, "interactive": { "type": "number", "description": "The maximum Time to Interactive metric threshold", "format": "float" } } }, "LinkCheckerActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "cache_base_image": { "type": "boolean", "description": "Defines whether to cache the base Docker image" }, "scan_url": { "type": "string", "description": "The address of the site to be checked by the validator." }, "ba_username": { "type": "string", "description": "The basic auth username value." }, "ba_password": { "type": "string", "description": "The basic auth password value." }, "max_results": { "type": "integer", "description": "The maximum number of results to return", "format": "int32" }, "cookies": { "type": "array", "description": "Set the cookie name/value. Can be given more than once.", "items": { "$ref": "#/components/schemas/CookieView" } }, "threads": { "type": "integer", "description": "Generate no more than the given number of threads. The default number of threads is 10. To disable threading specify a non-positive number.", "format": "int32" }, "depth": { "type": "integer", "description": "Check recursively all links up to the given depth. A negative depth will enable infinite recursion. The default depth is infinite.", "format": "int32" }, "connection_timeout": { "type": "integer", "description": "Set the timeout for connection attempts in seconds. The default timeout is 60 seconds.", "format": "int32" }, "user_agent": { "type": "string", "description": "Specify the User-Agent string to send to the HTTP server, for example `Mozilla/4.0`. The default is `LinkChecker/X.Y` where X.Y is the current version of LinkChecker." }, "requests_per_host": { "type": "integer", "description": "Limit the maximum number of HTTP requests per second to one host. The average number of requests per second is approximately one third of the maximum. Values less than 1 and at least 0.001 can be used. To use values greater than 10, the HTTP server must return a \"LinkChecker\" response header. The default is 10.", "format": "int32" }, "respect_robot_exclusions": { "type": "boolean", "description": "When using HTTP, fetch robots.txt, and confirm whether each URL should be accessed before checking. The default is to use robots.txt files." }, "check_ssl_certificate": { "type": "boolean", "description": "If set to zero, it disables the SSL certificate checking. If set to one, it enables the SSL certificate checking with the provided CA certificate file. If a filename is specified, it will be used as the certificate file." }, "internal_links": { "type": "string", "description": "The regular expression to add more URLs recognized as internal links. The default is that URLs given on the command line are internal." }, "check_external_links": { "type": "boolean", "description": "Check external links. The default is to check internal links only." }, "ignore_urls": { "type": "array", "description": "Only check the syntax of URLs matching the given regular expressions.", "items": { "type": "string", "description": "Only check the syntax of URLs matching the given regular expressions." } }, "no_follow_urls": { "type": "array", "description": "Check but do not recurse into URLs matching the given regular expressions.", "items": { "type": "string", "description": "Check but do not recurse into URLs matching the given regular expressions." } }, "warning_regex": { "type": "string", "description": "Only check syntax of URLs matching the given regular expressions." }, "html_form_auth_username_input_name": { "type": "string", "description": "The name attribute of the username input element." }, "html_form_auth_password_input_name": { "type": "string", "description": "The name attribute of the password input element." }, "html_form_auth_username": { "type": "string", "description": "The HTML form username value." }, "html_form_auth_password": { "type": "string", "description": "The HTML form password value." }, "html_form_auth_url": { "type": "string", "description": "The URL of a login page to be visited before link checking. The page is expected to contain an HTML form to collect credentials and submit them to the address in its action attribute using an HTTP POST request." } } }, "LinkValidatorActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "website": { "type": "string", "description": "The URL of the website to validate" }, "depth": { "type": "integer", "description": "Check recursively all links up to the given depth", "format": "int32" }, "ignored_prefixes": { "type": "array", "description": "URL prefixes to ignore during validation", "items": { "type": "string", "description": "URL prefixes to ignore during validation" } } } }, "LinuxNativeBuildActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "working_directory": { "type": "string", "description": "The directory in which the pipeline filesystem will be mounted" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "commands": { "type": "array", "description": "The commands to execute in the native build environment", "items": { "type": "string", "description": "The commands to execute in the native build environment" } }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "vm_from_prev_action": { "type": "boolean", "description": "If set to `true`, the VM from the previous action will be used" }, "vm_action_id": { "type": "integer", "description": "The ID of the action from which the VM will be used", "format": "int32" }, "vm_action_name": { "type": "string", "description": "The name of the action from which the VM will be used" }, "instance_type": { "type": "string", "description": "The type of instance to use for the native build", "enum": [ "GENERAL_MEDIUM", "GENERAL_LARGE", "GENERAL_XLARGE", "GENERAL_2XLARGE", "COMPUTE_MEDIUM", "COMPUTE_LARGE", "COMPUTE_XLARGE", "COMPUTE_2XLARGE", "ARM_GENERAL_MEDIUM", "ARM_GENERAL_LARGE", "ARM_GENERAL_XLARGE", "ARM_GENERAL_2XLARGE", "ARM_COMPUTE_MEDIUM", "ARM_COMPUTE_LARGE", "ARM_COMPUTE_XLARGE", "ARM_COMPUTE_2XLARGE" ] }, "sync_paths": { "type": "array", "description": "Define file paths that should be copied before (`PIPELINE_TO_VM`) and after the execution (`VM_TO_PIPELINE`).", "items": { "$ref": "#/components/schemas/SyncPathView" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "distribution": { "type": "string", "description": "Defines the image used to create the VM", "enum": [ "UBUNTU_20_04", "AMI", "WINDOWS_SERVER_2019", "PREVIOUS_ACTION" ] }, "ami": { "$ref": "#/components/schemas/AmiView" } } }, "LogglyActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "content": { "type": "string", "description": "The content of the notification." }, "tags": { "uniqueItems": true, "type": "array", "description": "The list of Loggly tags used for segmentation and filtering.", "items": { "type": "string", "description": "The list of Loggly tags used for segmentation and filtering." } } } }, "MacCordovaNativeBuildActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "working_directory": { "type": "string", "description": "The directory in which the pipeline filesystem will be mounted" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "commands": { "type": "array", "description": "The commands to execute in the native build environment", "items": { "type": "string", "description": "The commands to execute in the native build environment" } }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "vm_from_prev_action": { "type": "boolean", "description": "If set to `true`, the VM from the previous action will be used" }, "vm_action_id": { "type": "integer", "description": "The ID of the action from which the VM will be used", "format": "int32" }, "vm_action_name": { "type": "string", "description": "The name of the action from which the VM will be used" }, "instance_type": { "type": "string", "description": "The type of instance to use for the native build", "enum": [ "GENERAL_MEDIUM", "GENERAL_LARGE", "GENERAL_XLARGE", "GENERAL_2XLARGE", "COMPUTE_MEDIUM", "COMPUTE_LARGE", "COMPUTE_XLARGE", "COMPUTE_2XLARGE", "ARM_GENERAL_MEDIUM", "ARM_GENERAL_LARGE", "ARM_GENERAL_XLARGE", "ARM_GENERAL_2XLARGE", "ARM_COMPUTE_MEDIUM", "ARM_COMPUTE_LARGE", "ARM_COMPUTE_XLARGE", "ARM_COMPUTE_2XLARGE" ] }, "xcode_version": { "type": "string", "description": "The version of Xcode to use" }, "pre_start_simulators": { "type": "array", "description": "The list of simulators to start before the build", "items": { "type": "string", "description": "The list of simulators to start before the build" } }, "node_version": { "type": "string", "description": "The version of Node.js to use" }, "flutter_version": { "type": "string", "description": "The version of Flutter to use" }, "archive_location": { "type": "string", "description": "The path to the archive location" }, "certificates": { "type": "array", "description": "The list of certificates to use for signing", "items": { "type": "string", "description": "The list of certificates to use for signing" } }, "provision_profiles": { "type": "array", "description": "The list of provisioning profiles to use", "items": { "type": "string", "description": "The list of provisioning profiles to use" } }, "sign_mode": { "type": "string", "description": "The signing mode", "enum": [ "MANUAL", "AUTOMATIC" ] }, "distribution_method": { "type": "string", "description": "The distribution method", "enum": [ "APP_STORE", "AD_HOC", "DEVELOPMENT", "ENTERPRISE" ] }, "export_location": { "type": "string", "description": "The path to export the signed app" }, "property_list_source": { "type": "string", "description": "The source of the property list", "enum": [ "GENERATED", "PIPELINE_VOLUME", "VARIABLE", "ACTION" ] }, "property_list": { "type": "string", "description": "The content of the property list" }, "validate_before_upload": { "type": "boolean", "description": "If set to `true`, the app will be validated before upload" }, "submit_for_review": { "type": "boolean", "description": "If set to `true`, the app will be submitted for review" }, "skip_metadata": { "type": "boolean", "description": "If set to `true`, metadata will not be uploaded" }, "skip_app_version_update": { "type": "boolean", "description": "If set to `true`, the app version will not be updated" }, "skip_screenshots": { "type": "boolean", "description": "If set to `true`, screenshots will not be uploaded" }, "sync_paths": { "type": "array", "description": "Define file paths that should be copied before (`PIPELINE_TO_VM`) and after the execution (`VM_TO_PIPELINE`).", "items": { "$ref": "#/components/schemas/SyncPathView" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] } } }, "MacDeployNativeBuildActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "working_directory": { "type": "string", "description": "The directory in which the pipeline filesystem will be mounted" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "commands": { "type": "array", "description": "The commands to execute in the native build environment", "items": { "type": "string", "description": "The commands to execute in the native build environment" } }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "vm_from_prev_action": { "type": "boolean", "description": "If set to `true`, the VM from the previous action will be used" }, "vm_action_id": { "type": "integer", "description": "The ID of the action from which the VM will be used", "format": "int32" }, "vm_action_name": { "type": "string", "description": "The name of the action from which the VM will be used" }, "instance_type": { "type": "string", "description": "The type of instance to use for the native build", "enum": [ "GENERAL_MEDIUM", "GENERAL_LARGE", "GENERAL_XLARGE", "GENERAL_2XLARGE", "COMPUTE_MEDIUM", "COMPUTE_LARGE", "COMPUTE_XLARGE", "COMPUTE_2XLARGE", "ARM_GENERAL_MEDIUM", "ARM_GENERAL_LARGE", "ARM_GENERAL_XLARGE", "ARM_GENERAL_2XLARGE", "ARM_COMPUTE_MEDIUM", "ARM_COMPUTE_LARGE", "ARM_COMPUTE_XLARGE", "ARM_COMPUTE_2XLARGE" ] }, "xcode_version": { "type": "string", "description": "The version of Xcode to use" }, "pre_start_simulators": { "type": "array", "description": "The list of simulators to start before the build", "items": { "type": "string", "description": "The list of simulators to start before the build" } }, "node_version": { "type": "string", "description": "The version of Node.js to use" }, "flutter_version": { "type": "string", "description": "The version of Flutter to use" }, "archive_location": { "type": "string", "description": "The path to the archive location" }, "certificates": { "type": "array", "description": "The list of certificates to use for signing", "items": { "type": "string", "description": "The list of certificates to use for signing" } }, "provision_profiles": { "type": "array", "description": "The list of provisioning profiles to use", "items": { "type": "string", "description": "The list of provisioning profiles to use" } }, "sign_mode": { "type": "string", "description": "The signing mode", "enum": [ "MANUAL", "AUTOMATIC" ] }, "distribution_method": { "type": "string", "description": "The distribution method", "enum": [ "APP_STORE", "AD_HOC", "DEVELOPMENT", "ENTERPRISE" ] }, "export_location": { "type": "string", "description": "The path to export the signed app" }, "property_list_source": { "type": "string", "description": "The source of the property list", "enum": [ "GENERATED", "PIPELINE_VOLUME", "VARIABLE", "ACTION" ] }, "property_list": { "type": "string", "description": "The content of the property list" }, "validate_before_upload": { "type": "boolean", "description": "If set to `true`, the app will be validated before upload" }, "submit_for_review": { "type": "boolean", "description": "If set to `true`, the app will be submitted for review" }, "skip_metadata": { "type": "boolean", "description": "If set to `true`, metadata will not be uploaded" }, "skip_app_version_update": { "type": "boolean", "description": "If set to `true`, the app version will not be updated" }, "skip_screenshots": { "type": "boolean", "description": "If set to `true`, screenshots will not be uploaded" }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" } } }, "MacFastlaneNativeBuildActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "working_directory": { "type": "string", "description": "The directory in which the pipeline filesystem will be mounted" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "commands": { "type": "array", "description": "The commands to execute in the native build environment", "items": { "type": "string", "description": "The commands to execute in the native build environment" } }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "vm_from_prev_action": { "type": "boolean", "description": "If set to `true`, the VM from the previous action will be used" }, "vm_action_id": { "type": "integer", "description": "The ID of the action from which the VM will be used", "format": "int32" }, "vm_action_name": { "type": "string", "description": "The name of the action from which the VM will be used" }, "instance_type": { "type": "string", "description": "The type of instance to use for the native build", "enum": [ "GENERAL_MEDIUM", "GENERAL_LARGE", "GENERAL_XLARGE", "GENERAL_2XLARGE", "COMPUTE_MEDIUM", "COMPUTE_LARGE", "COMPUTE_XLARGE", "COMPUTE_2XLARGE", "ARM_GENERAL_MEDIUM", "ARM_GENERAL_LARGE", "ARM_GENERAL_XLARGE", "ARM_GENERAL_2XLARGE", "ARM_COMPUTE_MEDIUM", "ARM_COMPUTE_LARGE", "ARM_COMPUTE_XLARGE", "ARM_COMPUTE_2XLARGE" ] }, "xcode_version": { "type": "string", "description": "The version of Xcode to use" }, "pre_start_simulators": { "type": "array", "description": "The list of simulators to start before the build", "items": { "type": "string", "description": "The list of simulators to start before the build" } }, "node_version": { "type": "string", "description": "The version of Node.js to use" }, "flutter_version": { "type": "string", "description": "The version of Flutter to use" }, "archive_location": { "type": "string", "description": "The path to the archive location" }, "certificates": { "type": "array", "description": "The list of certificates to use for signing", "items": { "type": "string", "description": "The list of certificates to use for signing" } }, "provision_profiles": { "type": "array", "description": "The list of provisioning profiles to use", "items": { "type": "string", "description": "The list of provisioning profiles to use" } }, "sign_mode": { "type": "string", "description": "The signing mode", "enum": [ "MANUAL", "AUTOMATIC" ] }, "distribution_method": { "type": "string", "description": "The distribution method", "enum": [ "APP_STORE", "AD_HOC", "DEVELOPMENT", "ENTERPRISE" ] }, "export_location": { "type": "string", "description": "The path to export the signed app" }, "property_list_source": { "type": "string", "description": "The source of the property list", "enum": [ "GENERATED", "PIPELINE_VOLUME", "VARIABLE", "ACTION" ] }, "property_list": { "type": "string", "description": "The content of the property list" }, "validate_before_upload": { "type": "boolean", "description": "If set to `true`, the app will be validated before upload" }, "submit_for_review": { "type": "boolean", "description": "If set to `true`, the app will be submitted for review" }, "skip_metadata": { "type": "boolean", "description": "If set to `true`, metadata will not be uploaded" }, "skip_app_version_update": { "type": "boolean", "description": "If set to `true`, the app version will not be updated" }, "skip_screenshots": { "type": "boolean", "description": "If set to `true`, screenshots will not be uploaded" }, "sync_paths": { "type": "array", "description": "Define file paths that should be copied before (`PIPELINE_TO_VM`) and after the execution (`VM_TO_PIPELINE`).", "items": { "$ref": "#/components/schemas/SyncPathView" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] } } }, "MacFlutterNativeBuildActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "working_directory": { "type": "string", "description": "The directory in which the pipeline filesystem will be mounted" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "commands": { "type": "array", "description": "The commands to execute in the native build environment", "items": { "type": "string", "description": "The commands to execute in the native build environment" } }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "vm_from_prev_action": { "type": "boolean", "description": "If set to `true`, the VM from the previous action will be used" }, "vm_action_id": { "type": "integer", "description": "The ID of the action from which the VM will be used", "format": "int32" }, "vm_action_name": { "type": "string", "description": "The name of the action from which the VM will be used" }, "instance_type": { "type": "string", "description": "The type of instance to use for the native build", "enum": [ "GENERAL_MEDIUM", "GENERAL_LARGE", "GENERAL_XLARGE", "GENERAL_2XLARGE", "COMPUTE_MEDIUM", "COMPUTE_LARGE", "COMPUTE_XLARGE", "COMPUTE_2XLARGE", "ARM_GENERAL_MEDIUM", "ARM_GENERAL_LARGE", "ARM_GENERAL_XLARGE", "ARM_GENERAL_2XLARGE", "ARM_COMPUTE_MEDIUM", "ARM_COMPUTE_LARGE", "ARM_COMPUTE_XLARGE", "ARM_COMPUTE_2XLARGE" ] }, "xcode_version": { "type": "string", "description": "The version of Xcode to use" }, "pre_start_simulators": { "type": "array", "description": "The list of simulators to start before the build", "items": { "type": "string", "description": "The list of simulators to start before the build" } }, "node_version": { "type": "string", "description": "The version of Node.js to use" }, "flutter_version": { "type": "string", "description": "The version of Flutter to use" }, "archive_location": { "type": "string", "description": "The path to the archive location" }, "certificates": { "type": "array", "description": "The list of certificates to use for signing", "items": { "type": "string", "description": "The list of certificates to use for signing" } }, "provision_profiles": { "type": "array", "description": "The list of provisioning profiles to use", "items": { "type": "string", "description": "The list of provisioning profiles to use" } }, "sign_mode": { "type": "string", "description": "The signing mode", "enum": [ "MANUAL", "AUTOMATIC" ] }, "distribution_method": { "type": "string", "description": "The distribution method", "enum": [ "APP_STORE", "AD_HOC", "DEVELOPMENT", "ENTERPRISE" ] }, "export_location": { "type": "string", "description": "The path to export the signed app" }, "property_list_source": { "type": "string", "description": "The source of the property list", "enum": [ "GENERATED", "PIPELINE_VOLUME", "VARIABLE", "ACTION" ] }, "property_list": { "type": "string", "description": "The content of the property list" }, "validate_before_upload": { "type": "boolean", "description": "If set to `true`, the app will be validated before upload" }, "submit_for_review": { "type": "boolean", "description": "If set to `true`, the app will be submitted for review" }, "skip_metadata": { "type": "boolean", "description": "If set to `true`, metadata will not be uploaded" }, "skip_app_version_update": { "type": "boolean", "description": "If set to `true`, the app version will not be updated" }, "skip_screenshots": { "type": "boolean", "description": "If set to `true`, screenshots will not be uploaded" }, "sync_paths": { "type": "array", "description": "Define file paths that should be copied before (`PIPELINE_TO_VM`) and after the execution (`VM_TO_PIPELINE`).", "items": { "$ref": "#/components/schemas/SyncPathView" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] } } }, "MacNativeBuildActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "working_directory": { "type": "string", "description": "The directory in which the pipeline filesystem will be mounted" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "commands": { "type": "array", "description": "The commands to execute in the native build environment", "items": { "type": "string", "description": "The commands to execute in the native build environment" } }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "vm_from_prev_action": { "type": "boolean", "description": "If set to `true`, the VM from the previous action will be used" }, "vm_action_id": { "type": "integer", "description": "The ID of the action from which the VM will be used", "format": "int32" }, "vm_action_name": { "type": "string", "description": "The name of the action from which the VM will be used" }, "instance_type": { "type": "string", "description": "The type of instance to use for the native build", "enum": [ "GENERAL_MEDIUM", "GENERAL_LARGE", "GENERAL_XLARGE", "GENERAL_2XLARGE", "COMPUTE_MEDIUM", "COMPUTE_LARGE", "COMPUTE_XLARGE", "COMPUTE_2XLARGE", "ARM_GENERAL_MEDIUM", "ARM_GENERAL_LARGE", "ARM_GENERAL_XLARGE", "ARM_GENERAL_2XLARGE", "ARM_COMPUTE_MEDIUM", "ARM_COMPUTE_LARGE", "ARM_COMPUTE_XLARGE", "ARM_COMPUTE_2XLARGE" ] }, "xcode_version": { "type": "string", "description": "The version of Xcode to use" }, "pre_start_simulators": { "type": "array", "description": "The list of simulators to start before the build", "items": { "type": "string", "description": "The list of simulators to start before the build" } }, "node_version": { "type": "string", "description": "The version of Node.js to use" }, "flutter_version": { "type": "string", "description": "The version of Flutter to use" }, "archive_location": { "type": "string", "description": "The path to the archive location" }, "certificates": { "type": "array", "description": "The list of certificates to use for signing", "items": { "type": "string", "description": "The list of certificates to use for signing" } }, "provision_profiles": { "type": "array", "description": "The list of provisioning profiles to use", "items": { "type": "string", "description": "The list of provisioning profiles to use" } }, "sign_mode": { "type": "string", "description": "The signing mode", "enum": [ "MANUAL", "AUTOMATIC" ] }, "distribution_method": { "type": "string", "description": "The distribution method", "enum": [ "APP_STORE", "AD_HOC", "DEVELOPMENT", "ENTERPRISE" ] }, "export_location": { "type": "string", "description": "The path to export the signed app" }, "property_list_source": { "type": "string", "description": "The source of the property list", "enum": [ "GENERATED", "PIPELINE_VOLUME", "VARIABLE", "ACTION" ] }, "property_list": { "type": "string", "description": "The content of the property list" }, "validate_before_upload": { "type": "boolean", "description": "If set to `true`, the app will be validated before upload" }, "submit_for_review": { "type": "boolean", "description": "If set to `true`, the app will be submitted for review" }, "skip_metadata": { "type": "boolean", "description": "If set to `true`, metadata will not be uploaded" }, "skip_app_version_update": { "type": "boolean", "description": "If set to `true`, the app version will not be updated" }, "skip_screenshots": { "type": "boolean", "description": "If set to `true`, screenshots will not be uploaded" }, "sync_paths": { "type": "array", "description": "Define file paths that should be copied before (`PIPELINE_TO_VM`) and after the execution (`VM_TO_PIPELINE`).", "items": { "$ref": "#/components/schemas/SyncPathView" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] } } }, "MacReactNativeBuildActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "working_directory": { "type": "string", "description": "The directory in which the pipeline filesystem will be mounted" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "commands": { "type": "array", "description": "The commands to execute in the native build environment", "items": { "type": "string", "description": "The commands to execute in the native build environment" } }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "vm_from_prev_action": { "type": "boolean", "description": "If set to `true`, the VM from the previous action will be used" }, "vm_action_id": { "type": "integer", "description": "The ID of the action from which the VM will be used", "format": "int32" }, "vm_action_name": { "type": "string", "description": "The name of the action from which the VM will be used" }, "instance_type": { "type": "string", "description": "The type of instance to use for the native build", "enum": [ "GENERAL_MEDIUM", "GENERAL_LARGE", "GENERAL_XLARGE", "GENERAL_2XLARGE", "COMPUTE_MEDIUM", "COMPUTE_LARGE", "COMPUTE_XLARGE", "COMPUTE_2XLARGE", "ARM_GENERAL_MEDIUM", "ARM_GENERAL_LARGE", "ARM_GENERAL_XLARGE", "ARM_GENERAL_2XLARGE", "ARM_COMPUTE_MEDIUM", "ARM_COMPUTE_LARGE", "ARM_COMPUTE_XLARGE", "ARM_COMPUTE_2XLARGE" ] }, "xcode_version": { "type": "string", "description": "The version of Xcode to use" }, "pre_start_simulators": { "type": "array", "description": "The list of simulators to start before the build", "items": { "type": "string", "description": "The list of simulators to start before the build" } }, "node_version": { "type": "string", "description": "The version of Node.js to use" }, "flutter_version": { "type": "string", "description": "The version of Flutter to use" }, "archive_location": { "type": "string", "description": "The path to the archive location" }, "certificates": { "type": "array", "description": "The list of certificates to use for signing", "items": { "type": "string", "description": "The list of certificates to use for signing" } }, "provision_profiles": { "type": "array", "description": "The list of provisioning profiles to use", "items": { "type": "string", "description": "The list of provisioning profiles to use" } }, "sign_mode": { "type": "string", "description": "The signing mode", "enum": [ "MANUAL", "AUTOMATIC" ] }, "distribution_method": { "type": "string", "description": "The distribution method", "enum": [ "APP_STORE", "AD_HOC", "DEVELOPMENT", "ENTERPRISE" ] }, "export_location": { "type": "string", "description": "The path to export the signed app" }, "property_list_source": { "type": "string", "description": "The source of the property list", "enum": [ "GENERATED", "PIPELINE_VOLUME", "VARIABLE", "ACTION" ] }, "property_list": { "type": "string", "description": "The content of the property list" }, "validate_before_upload": { "type": "boolean", "description": "If set to `true`, the app will be validated before upload" }, "submit_for_review": { "type": "boolean", "description": "If set to `true`, the app will be submitted for review" }, "skip_metadata": { "type": "boolean", "description": "If set to `true`, metadata will not be uploaded" }, "skip_app_version_update": { "type": "boolean", "description": "If set to `true`, the app version will not be updated" }, "skip_screenshots": { "type": "boolean", "description": "If set to `true`, screenshots will not be uploaded" }, "sync_paths": { "type": "array", "description": "Define file paths that should be copied before (`PIPELINE_TO_VM`) and after the execution (`VM_TO_PIPELINE`).", "items": { "$ref": "#/components/schemas/SyncPathView" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] } } }, "MacSignNativeBuildActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "working_directory": { "type": "string", "description": "The directory in which the pipeline filesystem will be mounted" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "commands": { "type": "array", "description": "The commands to execute in the native build environment", "items": { "type": "string", "description": "The commands to execute in the native build environment" } }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "vm_from_prev_action": { "type": "boolean", "description": "If set to `true`, the VM from the previous action will be used" }, "vm_action_id": { "type": "integer", "description": "The ID of the action from which the VM will be used", "format": "int32" }, "vm_action_name": { "type": "string", "description": "The name of the action from which the VM will be used" }, "instance_type": { "type": "string", "description": "The type of instance to use for the native build", "enum": [ "GENERAL_MEDIUM", "GENERAL_LARGE", "GENERAL_XLARGE", "GENERAL_2XLARGE", "COMPUTE_MEDIUM", "COMPUTE_LARGE", "COMPUTE_XLARGE", "COMPUTE_2XLARGE", "ARM_GENERAL_MEDIUM", "ARM_GENERAL_LARGE", "ARM_GENERAL_XLARGE", "ARM_GENERAL_2XLARGE", "ARM_COMPUTE_MEDIUM", "ARM_COMPUTE_LARGE", "ARM_COMPUTE_XLARGE", "ARM_COMPUTE_2XLARGE" ] }, "xcode_version": { "type": "string", "description": "The version of Xcode to use" }, "pre_start_simulators": { "type": "array", "description": "The list of simulators to start before the build", "items": { "type": "string", "description": "The list of simulators to start before the build" } }, "node_version": { "type": "string", "description": "The version of Node.js to use" }, "flutter_version": { "type": "string", "description": "The version of Flutter to use" }, "archive_location": { "type": "string", "description": "The path to the archive location" }, "certificates": { "type": "array", "description": "The list of certificates to use for signing", "items": { "type": "string", "description": "The list of certificates to use for signing" } }, "provision_profiles": { "type": "array", "description": "The list of provisioning profiles to use", "items": { "type": "string", "description": "The list of provisioning profiles to use" } }, "sign_mode": { "type": "string", "description": "The signing mode", "enum": [ "MANUAL", "AUTOMATIC" ] }, "distribution_method": { "type": "string", "description": "The distribution method", "enum": [ "APP_STORE", "AD_HOC", "DEVELOPMENT", "ENTERPRISE" ] }, "export_location": { "type": "string", "description": "The path to export the signed app" }, "property_list_source": { "type": "string", "description": "The source of the property list", "enum": [ "GENERATED", "PIPELINE_VOLUME", "VARIABLE", "ACTION" ] }, "property_list": { "type": "string", "description": "The content of the property list" }, "validate_before_upload": { "type": "boolean", "description": "If set to `true`, the app will be validated before upload" }, "submit_for_review": { "type": "boolean", "description": "If set to `true`, the app will be submitted for review" }, "skip_metadata": { "type": "boolean", "description": "If set to `true`, metadata will not be uploaded" }, "skip_app_version_update": { "type": "boolean", "description": "If set to `true`, the app version will not be updated" }, "skip_screenshots": { "type": "boolean", "description": "If set to `true`, screenshots will not be uploaded" } } }, "MacVmNativeBuildActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "working_directory": { "type": "string", "description": "The directory in which the pipeline filesystem will be mounted" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "commands": { "type": "array", "description": "The commands to execute in the native build environment", "items": { "type": "string", "description": "The commands to execute in the native build environment" } }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "vm_from_prev_action": { "type": "boolean", "description": "If set to `true`, the VM from the previous action will be used" }, "vm_action_id": { "type": "integer", "description": "The ID of the action from which the VM will be used", "format": "int32" }, "vm_action_name": { "type": "string", "description": "The name of the action from which the VM will be used" }, "instance_type": { "type": "string", "description": "The type of instance to use for the native build", "enum": [ "GENERAL_MEDIUM", "GENERAL_LARGE", "GENERAL_XLARGE", "GENERAL_2XLARGE", "COMPUTE_MEDIUM", "COMPUTE_LARGE", "COMPUTE_XLARGE", "COMPUTE_2XLARGE", "ARM_GENERAL_MEDIUM", "ARM_GENERAL_LARGE", "ARM_GENERAL_XLARGE", "ARM_GENERAL_2XLARGE", "ARM_COMPUTE_MEDIUM", "ARM_COMPUTE_LARGE", "ARM_COMPUTE_XLARGE", "ARM_COMPUTE_2XLARGE" ] }, "xcode_version": { "type": "string", "description": "The version of Xcode to use" }, "pre_start_simulators": { "type": "array", "description": "The list of simulators to start before the build", "items": { "type": "string", "description": "The list of simulators to start before the build" } }, "node_version": { "type": "string", "description": "The version of Node.js to use" }, "flutter_version": { "type": "string", "description": "The version of Flutter to use" }, "archive_location": { "type": "string", "description": "The path to the archive location" }, "certificates": { "type": "array", "description": "The list of certificates to use for signing", "items": { "type": "string", "description": "The list of certificates to use for signing" } }, "provision_profiles": { "type": "array", "description": "The list of provisioning profiles to use", "items": { "type": "string", "description": "The list of provisioning profiles to use" } }, "sign_mode": { "type": "string", "description": "The signing mode", "enum": [ "MANUAL", "AUTOMATIC" ] }, "distribution_method": { "type": "string", "description": "The distribution method", "enum": [ "APP_STORE", "AD_HOC", "DEVELOPMENT", "ENTERPRISE" ] }, "export_location": { "type": "string", "description": "The path to export the signed app" }, "property_list_source": { "type": "string", "description": "The source of the property list", "enum": [ "GENERATED", "PIPELINE_VOLUME", "VARIABLE", "ACTION" ] }, "property_list": { "type": "string", "description": "The content of the property list" }, "validate_before_upload": { "type": "boolean", "description": "If set to `true`, the app will be validated before upload" }, "submit_for_review": { "type": "boolean", "description": "If set to `true`, the app will be submitted for review" }, "skip_metadata": { "type": "boolean", "description": "If set to `true`, metadata will not be uploaded" }, "skip_app_version_update": { "type": "boolean", "description": "If set to `true`, the app version will not be updated" }, "skip_screenshots": { "type": "boolean", "description": "If set to `true`, screenshots will not be uploaded" }, "sync_paths": { "type": "array", "description": "Define file paths that should be copied before (`PIPELINE_TO_VM`) and after the execution (`VM_TO_PIPELINE`).", "items": { "$ref": "#/components/schemas/SyncPathView" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] } } }, "ManageSandboxActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "operation": { "type": "string", "description": "The operation to perform on the sandbox", "enum": [ "START", "STOP", "DELETE", "APP_START", "APP_STOP", "CREATE_SNAPSHOT", "APP_RESTART" ] }, "referenced_action_id": { "type": "integer", "description": "The numerical ID of the referenced action that created or manages the sandbox", "format": "int32" }, "referenced_action_name": { "type": "string", "description": "The name of the referenced action that created or manages the sandbox" }, "snapshot_name": { "type": "string", "description": "The name for the snapshot when `operation` is `CREATE_SNAPSHOT`. Can use Buddy variables like `$BUDDY_RUN_ID`." }, "targets": { "type": "array", "description": "Array of sandbox targets to perform the operation on. Can be specific sandbox names or filters.", "items": { "$ref": "#/components/schemas/TargetView" } } } }, "MicrosoftTeamsActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "title": { "type": "string", "description": "The title of the notification." }, "content": { "type": "string", "description": "The content of the notification." }, "recipients": { "type": "string", "description": "The recipient of the notification: email address." }, "send_as_html": { "type": "boolean", "description": "Defines whether to send the content as HTML." }, "file_attachments": { "type": "array", "description": "The attached files.", "items": { "type": "string", "description": "The attached files." } } } }, "MongoshCliActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "version": { "type": "string", "description": "The version of the MongoDB Docker image. Default: `latest`" }, "targets": { "type": "array", "description": "The list of MongoDB targets for this action", "items": { "$ref": "#/components/schemas/TargetView" } } } }, "MssqlCliActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "targets": { "type": "array", "description": "The list of MSSQL targets for this action", "items": { "$ref": "#/components/schemas/TargetView" } } } }, "MysqlCliActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "version": { "type": "string", "description": "The version of the MySQL Docker image. Default: `latest`" }, "targets": { "type": "array", "description": "The list of MySQL targets for this action", "items": { "$ref": "#/components/schemas/TargetView" } } } }, "NetlifyActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "site_id": { "type": "string", "description": "The API ID in the site details." }, "version": { "type": "string", "description": "The version of the Netlify CLI to use" } } }, "NewRelicActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "changelog": { "type": "string", "description": "The content of the notification." }, "description": { "type": "string", "description": "The title of the notification." }, "application_id": { "type": "string", "description": "The ID of the New Relic application." }, "version": { "type": "string", "description": "The revision to which the application is deployed. If not set, the default value is $BUDDY_RUN_COMMIT." }, "region": { "type": "string", "description": "The New Relic region. Can be one of `US` or `EU`." } } }, "NewRelicCliActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" } } }, "NpmPublishActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "npm_registry": { "type": "string", "description": "The NPM registry to use for publishing the artifact", "enum": [ "NPM", "GIT_HUB", "OTHER" ] }, "access": { "type": "string", "description": "Whether artifact has public or restricted access", "enum": [ "RESTRICTED", "PUBLIC" ] }, "ignore_scripts": { "type": "boolean", "description": "If set to `true`, lifecycle scripts will not be executed during publish" }, "tag": { "type": "string", "description": "The distribution tag to use when publishing the artifact" }, "source_path": { "type": "string", "description": "The path to the artifact directory to publish" }, "registry": { "type": "string", "description": "The custom NPM registry URL to use for publishing" }, "token": { "type": "string", "description": "The authentication token for the NPM registry" } } }, "PingActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "destination": { "type": "string", "description": "The destination address for the network action" } } }, "PipelineIdentifierView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "identifier": { "type": "string", "description": "A human-readable ID of pipeline" }, "project": { "$ref": "#/components/schemas/ProjectNameView" } }, "description": "The target pipeline whose settings will be modified" }, "PipelineSettingsActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "cron": { "type": "string", "description": "The cron expression that defines the schedule for running the pipeline" }, "target_pipeline": { "$ref": "#/components/schemas/PipelineIdentifierView" } } }, "PlaywrightActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "working_directory": { "type": "string", "description": "The directory in which the pipeline filesystem will be mounted" }, "main_service_name": { "type": "string", "description": "The hostname of the container in which the action is run. The container will be available under this name in the docker network for services" }, "run_as_user": { "type": "string", "description": "All build commands are run as the default user defined in the selected Docker image. Can be set to another username (on the condition that this user exists in the selected image)" }, "version": { "type": "string", "description": "The version of the artifact from artifact registry" }, "docker_image_name": { "type": "string", "description": "The name of the Docker image" }, "docker_image_tag": { "type": "string", "description": "The tag of the Docker image" }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "mount_filesystem_disable": { "type": "boolean", "description": "If set to `true`, the filesystem will not be mounted in the container" }, "volume_mappings": { "type": "array", "description": "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)", "items": { "type": "string", "description": "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)" } }, "cached_dirs": { "type": "array", "description": "The dependencies & directories to be cached and available to every execution in this pipeline", "items": { "type": "string", "description": "The dependencies & directories to be cached and available to every execution in this pipeline" } }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "services": { "type": "array", "description": "The list of services attached to the build environment", "items": { "$ref": "#/components/schemas/ServiceView" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "registry": { "type": "string", "description": "The URL of the Docker registry" }, "insecure_registry": { "type": "boolean", "description": "If set to `true`, the registry will be accessed over HTTP instead of HTTPS" }, "login": { "type": "string", "description": "The username for the Docker registry" }, "target_stage": { "type": "string", "description": "The target stage of the Dockerfile" }, "password": { "type": "string", "description": "The password for the Docker registry" }, "region": { "type": "string", "description": "The region for the Docker registry (for AWS ECR)" }, "image_location": { "type": "string", "description": "The location of the image used by the action", "enum": [ "PUBLIC_REGISTRY", "PRIVATE_REGISTRY", "ACTION", "ARTIFACT_REGISTRY" ] }, "docker_registry": { "type": "string", "description": "The type of registry from which the image is retrieved", "enum": [ "NONE", "DOCKER_HUB", "AMAZON_ECR", "GOOGLE_GCR", "GOOGLE_ARTIFACT_REGISTRY", "OTHER", "GIT_HUB_CONTAINER_REGISTRY", "ARTIFACT_REGISTRY", "DIGITAL_OCEAN_CONTAINER_REGISTRY" ] }, "docker_build_action_id": { "type": "integer", "description": "The ID of the action from which the Docker image will be used", "format": "int32" }, "docker_build_action_name": { "type": "string", "description": "The name of the action from which the Docker image will be used" }, "export_container_path": { "type": "string", "description": "The path in the container to export" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "ignore_image_pull_failures": { "type": "boolean", "description": "If set to `true`, use cached image on timeouts (only for official images)" }, "cache_base_image": { "type": "boolean", "description": "If set to `true`, the cached version of the image is used, instead of being pulled each time" }, "reset_entrypoint": { "type": "boolean", "description": "If set to `true`, resets the default entrypoint set by the image. Default value: `false`" }, "vt_suite": { "type": "string", "description": "The visual tests suite identifier" }, "unit_tests_suite": { "type": "string", "description": "The unit tests suite identifier" }, "unit_tests_path": { "type": "string", "description": "The path to the unit tests results" }, "artifact": { "type": "string", "description": "The identifier of the artifact from artifact registry" } } }, "PostgresqlCliActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "version": { "type": "string", "description": "The version of the PostgreSQL Docker image. Default: `latest`" }, "targets": { "type": "array", "description": "The list of PostgreSQL targets for this action", "items": { "$ref": "#/components/schemas/TargetView" } } } }, "PowershellActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "working_directory": { "type": "string", "description": "The directory in which the PowerShell commands will be executed" }, "commands": { "type": "array", "description": "The PowerShell commands that will be executed", "items": { "type": "string", "description": "The PowerShell commands that will be executed" } }, "shell": { "type": "string", "description": "The shell type used for command execution" }, "execute_every_command": { "type": "boolean", "description": "If set to `true`, executes every command regardless of previous command failures" }, "run_as_script": { "type": "boolean", "description": "If set to `true`, commands will be executed as a PowerShell script" }, "targets": { "type": "array", "description": "The list of target servers where the PowerShell commands will be executed", "items": { "$ref": "#/components/schemas/TargetView" } } } }, "PromoteImageActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "same_location": { "type": "boolean", "description": "If set to `true`, promotes the image within the same registry (only tag changes). If `false`, promotes between different registries." }, "src": { "$ref": "#/components/schemas/PromoteImageView" }, "dest": { "$ref": "#/components/schemas/PromoteImageView" }, "insecure_registry": { "type": "boolean", "description": "If set to `true`, allows connection to insecure Docker registries" } } }, "PublishArtifactVersionActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "local_path": { "type": "string", "description": "The path to the local files to deploy" }, "remote_path": { "type": "string", "description": "The path on the remote server where files will be deployed" }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "deployment_includes": { "type": "array", "description": "The list of files or directories to include in deployment", "items": { "type": "string", "description": "The list of files or directories to include in deployment" } }, "input_type": { "type": "string", "description": "The type of source input", "enum": [ "SCM_REPOSITORY", "BUILD_ARTIFACTS" ] }, "deletion_disabled": { "type": "boolean", "description": "If set to `true`, files on the remote server will not be deleted" }, "use_temporary_files": { "type": "boolean", "description": "If set to `true`, files will be uploaded to a temporary directory first" }, "content_encoding": { "type": "string", "description": "The content encoding for deployed files" }, "versions": { "type": "array", "description": "The list of artifact versions to publish", "items": { "type": "string", "description": "The list of artifact versions to publish" } }, "artifact": { "type": "string", "description": "The human-readable ID of the artifact to publish" } } }, "PushActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "push_tags": { "type": "boolean", "description": "If set to `true`, tags will be pushed to the repository" }, "push_only_tags": { "type": "boolean", "description": "If set to `true`, only tags will be pushed without commits" }, "target_branch": { "type": "string", "description": "The target branch to push to" }, "without_force": { "type": "boolean", "description": "If set to `true`, force push will not be used" }, "isolated": { "type": "boolean", "description": "If set to `true`, the action will run in an isolated environment" }, "use_custom_gitignore": { "type": "boolean", "description": "If set to `true`, custom .gitignore rules will be used" }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "comment": { "type": "string", "description": "The commit message for the push" }, "tag": { "type": "string", "description": "The tag name to create and push" }, "custom_options": { "type": "string", "description": "Custom git push options" }, "targets": { "type": "array", "description": "The list of target repositories to push to", "items": { "$ref": "#/components/schemas/TargetView" } }, "commiter_email": { "type": "string", "description": "The email address of the committer" }, "signing_asset": { "type": "string", "description": "The name of the asset used for signing the commit" } } }, "PushbulletActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "content": { "type": "string", "description": "The content of the notification." }, "title": { "type": "string", "description": "The title of the notification." }, "link": { "type": "string", "description": "The link of the notification." }, "device": { "type": "string", "description": "The name of the device to which the notification will be sent." } } }, "PushoverActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "content": { "type": "string", "description": "The content of the notification." }, "title": { "type": "string", "description": "The title of the notification." }, "link": { "type": "string", "description": "The link of the notification." }, "link_title": { "type": "string", "description": "The title of the notification link." }, "priority": { "type": "string", "description": "Specifies the priority of the notification. Can be one of `LOW`, `NORMAL` or `HIGH`." }, "device": { "type": "string", "description": "The name of the device to which the notification will be sent." } } }, "RackspaceActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "local_path": { "type": "string", "description": "The path to the local files to deploy" }, "remote_path": { "type": "string", "description": "The path on the remote server where files will be deployed" }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "deployment_includes": { "type": "array", "description": "The list of files or directories to include in deployment", "items": { "type": "string", "description": "The list of files or directories to include in deployment" } }, "input_type": { "type": "string", "description": "The type of source input", "enum": [ "SCM_REPOSITORY", "BUILD_ARTIFACTS" ] }, "deletion_disabled": { "type": "boolean", "description": "If set to `true`, files on the remote server will not be deleted" }, "use_temporary_files": { "type": "boolean", "description": "If set to `true`, files will be uploaded to a temporary directory first" }, "content_encoding": { "type": "string", "description": "The content encoding for deployed files" }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "region": { "type": "string", "description": "The name of the Rackspace region." }, "container": { "type": "string", "description": "The name of the Rackspace container." } } }, "RaygunActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "token": { "type": "string", "description": "See `authToken` [here](https://raygun.com/documentation/product-guides/deployment-tracking/deployments-api/)." }, "api_key": { "type": "string", "description": "See `apiKey` [here](https://raygun.com/documentation/product-guides/deployment-tracking/deployments-api/)." }, "version": { "type": "string", "description": "See `version` [here](https://raygun.com/documentation/product-guides/deployment-tracking/deployments-api/)." }, "user": { "type": "string", "description": "See `ownerName` [here](https://raygun.com/documentation/product-guides/deployment-tracking/deployments-api/)." }, "email": { "type": "string", "description": "See `emailAddress` [here](https://raygun.com/documentation/product-guides/deployment-tracking/deployments-api/)." }, "comment": { "type": "string", "description": "See `comment` [here](https://raygun.com/documentation/product-guides/deployment-tracking/deployments-api/)." } } }, "ReplaceActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "local_path": { "type": "string", "description": "The path in the repository." }, "replacements": { "type": "array", "description": "The list of pairs of strings for replacement.", "items": { "$ref": "#/components/schemas/ReplacementView" } } } }, "RollbarActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "application": { "type": "string", "description": "The name of the Rollbar application" }, "comment": { "type": "string", "description": "The deployment comment" }, "rollbar_username": { "type": "string", "description": "The Rollbar username for the deployment" }, "user": { "type": "string", "description": "The user who initiated the deployment" }, "environment": { "type": "string", "description": "The deployment environment (e.g., production, staging)" } } }, "RsyncActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "local_path": { "type": "string", "description": "The path to the local files to synchronize" }, "deployment_excludes": { "type": "array", "description": "The list of paths to exclude from synchronization", "items": { "type": "string", "description": "The list of paths to exclude from synchronization" } }, "deployment_includes": { "type": "array", "description": "The list of paths to include in synchronization", "items": { "type": "string", "description": "The list of paths to include in synchronization" } }, "archive": { "type": "boolean", "description": "Enables archive mode, preserving permissions, timestamps, and symbolic links" }, "delete_extra_files": { "type": "boolean", "description": "Deletes files on the destination that don't exist in the source" }, "recursive": { "type": "boolean", "description": "Synchronizes directories recursively" }, "dirs": { "type": "boolean", "description": "Transfers directories without their contents" }, "compress": { "type": "boolean", "description": "Compresses files during transfer" }, "remote_path": { "type": "string", "description": "The path on the remote server where files will be synchronized" }, "arguments": { "type": "string", "description": "Additional rsync command-line arguments" }, "targets": { "type": "array", "description": "The list of servers to synchronize files to", "items": { "$ref": "#/components/schemas/TargetView" } } } }, "RunDockerContainerActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "working_directory": { "type": "string", "description": "The directory in which the pipeline filesystem will be mounted" }, "main_service_name": { "type": "string", "description": "The hostname of the container in which the action is run. The container will be available under this name in the docker network for services" }, "run_as_user": { "type": "string", "description": "All build commands are run as the default user defined in the selected Docker image. Can be set to another username (on the condition that this user exists in the selected image)" }, "version": { "type": "string", "description": "The version of the artifact from artifact registry" }, "docker_image_name": { "type": "string", "description": "The name of the Docker image" }, "docker_image_tag": { "type": "string", "description": "The tag of the Docker image" }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "mount_filesystem_disable": { "type": "boolean", "description": "If set to `true`, the filesystem will not be mounted in the container" }, "volume_mappings": { "type": "array", "description": "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)", "items": { "type": "string", "description": "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)" } }, "cached_dirs": { "type": "array", "description": "The dependencies & directories to be cached and available to every execution in this pipeline", "items": { "type": "string", "description": "The dependencies & directories to be cached and available to every execution in this pipeline" } }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "services": { "type": "array", "description": "The list of services attached to the build environment", "items": { "$ref": "#/components/schemas/ServiceView" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "registry": { "type": "string", "description": "The URL of the Docker registry" }, "insecure_registry": { "type": "boolean", "description": "If set to `true`, the registry will be accessed over HTTP instead of HTTPS" }, "login": { "type": "string", "description": "The username for the Docker registry" }, "target_stage": { "type": "string", "description": "The target stage of the Dockerfile" }, "password": { "type": "string", "description": "The password for the Docker registry" }, "region": { "type": "string", "description": "The region for the Docker registry (for AWS ECR)" }, "image_location": { "type": "string", "description": "The location of the image used by the action", "enum": [ "PUBLIC_REGISTRY", "PRIVATE_REGISTRY", "ACTION", "ARTIFACT_REGISTRY" ] }, "docker_registry": { "type": "string", "description": "The type of registry from which the image is retrieved", "enum": [ "NONE", "DOCKER_HUB", "AMAZON_ECR", "GOOGLE_GCR", "GOOGLE_ARTIFACT_REGISTRY", "OTHER", "GIT_HUB_CONTAINER_REGISTRY", "ARTIFACT_REGISTRY", "DIGITAL_OCEAN_CONTAINER_REGISTRY" ] }, "docker_build_action_id": { "type": "integer", "description": "The ID of the action from which the Docker image will be used", "format": "int32" }, "docker_build_action_name": { "type": "string", "description": "The name of the action from which the Docker image will be used" }, "export_container_path": { "type": "string", "description": "The path in the container to export" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "ignore_image_pull_failures": { "type": "boolean", "description": "If set to `true`, use cached image on timeouts (only for official images)" }, "cache_base_image": { "type": "boolean", "description": "If set to `true`, the cached version of the image is used, instead of being pulled each time" }, "reset_entrypoint": { "type": "boolean", "description": "If set to `true`, resets the default entrypoint set by the image. Default value: `false`" }, "vt_suite": { "type": "string", "description": "The visual tests suite identifier" }, "unit_tests_suite": { "type": "string", "description": "The unit tests suite identifier" }, "unit_tests_path": { "type": "string", "description": "The path to the unit tests results" }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "entrypoint": { "type": "string", "description": "The entrypoint to use for the Docker container" }, "inline_commands": { "type": "string", "description": "The commands to execute inside the Docker container" }, "artifact": { "type": "string", "description": "The identifier of the artifact from artifact registry" } } }, "RunNextPipelineActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "comment": { "type": "string", "description": "The comment for the pipeline execution" }, "revision": { "type": "string", "description": "The revision to execute" }, "specific_revision": { "type": "string", "description": "The specific revision identifier to execute" }, "next_pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "wait": { "type": "boolean", "description": "Wait for the pipeline execution to complete" }, "clear_cache": { "type": "boolean", "description": "Clear the cache before executing the pipeline" }, "refresh": { "type": "boolean", "description": "Refresh the repository before executing the pipeline" }, "environment": { "type": "string", "description": "The environment for the pipeline execution" }, "priority": { "type": "string", "description": "The priority of the pipeline execution" }, "artifact": { "type": "string", "description": "The artifact context identifier for the pipeline execution" } } }, "SandboxApplicationStartActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "sandbox_id": { "type": "string", "description": "The ID of the sandbox" }, "sandbox_references": { "uniqueItems": true, "type": "array", "description": "The set of sandbox reference types", "items": { "type": "string", "description": "The set of sandbox reference types", "enum": [ "BY_ID", "BY_TAGS", "BY_ACTION", "BY_NAME", "BY_PROJECT", "BY_DAYS" ] } }, "sandbox_project_id": { "type": "integer", "description": "The ID of the sandbox project", "format": "int32" }, "sandbox_project_name": { "type": "string", "description": "The name of the sandbox project" }, "tags": { "uniqueItems": true, "type": "array", "description": "The set of tags for the sandbox", "items": { "type": "string", "description": "The set of tags for the sandbox" } }, "referenced_sandbox_name": { "type": "string", "description": "The name of the referenced sandbox" }, "days": { "type": "integer", "description": "The number of days for sandbox retention", "format": "int32" }, "referenced_action_id": { "type": "integer", "description": "The ID of the referenced action", "format": "int32" }, "referenced_action_name": { "type": "string", "description": "The name of the referenced action" }, "sandbox_name": { "type": "string", "description": "The name of the sandbox" }, "snapshot_name": { "type": "string", "description": "The name of the snapshot" }, "snapshot_id": { "type": "string", "description": "The ID of the snapshot" }, "sandbox_distribution": { "type": "string", "description": "The distribution used for the sandbox" }, "resources": { "type": "string", "description": "The resource allocation for the sandbox", "enum": [ "1x2", "2x4", "3x6", "4x8", "5x10", "6x12", "7x14", "8x16", "9x18", "10x20", "11x22", "12x24", "CUSTOM" ] }, "return_existing": { "type": "boolean", "description": "If set to `true`, an existing sandbox will be returned" } } }, "SandboxApplicationStopActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "sandbox_id": { "type": "string", "description": "The ID of the sandbox" }, "sandbox_references": { "uniqueItems": true, "type": "array", "description": "The set of sandbox reference types", "items": { "type": "string", "description": "The set of sandbox reference types", "enum": [ "BY_ID", "BY_TAGS", "BY_ACTION", "BY_NAME", "BY_PROJECT", "BY_DAYS" ] } }, "sandbox_project_id": { "type": "integer", "description": "The ID of the sandbox project", "format": "int32" }, "sandbox_project_name": { "type": "string", "description": "The name of the sandbox project" }, "tags": { "uniqueItems": true, "type": "array", "description": "The set of tags for the sandbox", "items": { "type": "string", "description": "The set of tags for the sandbox" } }, "referenced_sandbox_name": { "type": "string", "description": "The name of the referenced sandbox" }, "days": { "type": "integer", "description": "The number of days for sandbox retention", "format": "int32" }, "referenced_action_id": { "type": "integer", "description": "The ID of the referenced action", "format": "int32" }, "referenced_action_name": { "type": "string", "description": "The name of the referenced action" }, "sandbox_name": { "type": "string", "description": "The name of the sandbox" }, "snapshot_name": { "type": "string", "description": "The name of the snapshot" }, "snapshot_id": { "type": "string", "description": "The ID of the snapshot" }, "sandbox_distribution": { "type": "string", "description": "The distribution used for the sandbox" }, "resources": { "type": "string", "description": "The resource allocation for the sandbox", "enum": [ "1x2", "2x4", "3x6", "4x8", "5x10", "6x12", "7x14", "8x16", "9x18", "10x20", "11x22", "12x24", "CUSTOM" ] }, "return_existing": { "type": "boolean", "description": "If set to `true`, an existing sandbox will be returned" } } }, "SandboxCreateFromSandboxActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "sandbox_id": { "type": "string", "description": "The ID of the sandbox" }, "sandbox_references": { "uniqueItems": true, "type": "array", "description": "The set of sandbox reference types", "items": { "type": "string", "description": "The set of sandbox reference types", "enum": [ "BY_ID", "BY_TAGS", "BY_ACTION", "BY_NAME", "BY_PROJECT", "BY_DAYS" ] } }, "sandbox_project_id": { "type": "integer", "description": "The ID of the sandbox project", "format": "int32" }, "sandbox_project_name": { "type": "string", "description": "The name of the sandbox project" }, "tags": { "uniqueItems": true, "type": "array", "description": "The set of tags for the sandbox", "items": { "type": "string", "description": "The set of tags for the sandbox" } }, "referenced_sandbox_name": { "type": "string", "description": "The name of the referenced sandbox" }, "days": { "type": "integer", "description": "The number of days for sandbox retention", "format": "int32" }, "referenced_action_id": { "type": "integer", "description": "The ID of the referenced action", "format": "int32" }, "referenced_action_name": { "type": "string", "description": "The name of the referenced action" }, "sandbox_name": { "type": "string", "description": "The name of the sandbox" }, "snapshot_name": { "type": "string", "description": "The name of the snapshot" }, "snapshot_id": { "type": "string", "description": "The ID of the snapshot" }, "sandbox_distribution": { "type": "string", "description": "The distribution used for the sandbox" }, "resources": { "type": "string", "description": "The resource allocation for the sandbox", "enum": [ "1x2", "2x4", "3x6", "4x8", "5x10", "6x12", "7x14", "8x16", "9x18", "10x20", "11x22", "12x24", "CUSTOM" ] }, "return_existing": { "type": "boolean", "description": "If set to `true`, an existing sandbox will be returned" } } }, "SandboxCreateFromSnapshotActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "sandbox_id": { "type": "string", "description": "The ID of the sandbox" }, "sandbox_references": { "uniqueItems": true, "type": "array", "description": "The set of sandbox reference types", "items": { "type": "string", "description": "The set of sandbox reference types", "enum": [ "BY_ID", "BY_TAGS", "BY_ACTION", "BY_NAME", "BY_PROJECT", "BY_DAYS" ] } }, "sandbox_project_id": { "type": "integer", "description": "The ID of the sandbox project", "format": "int32" }, "sandbox_project_name": { "type": "string", "description": "The name of the sandbox project" }, "tags": { "uniqueItems": true, "type": "array", "description": "The set of tags for the sandbox", "items": { "type": "string", "description": "The set of tags for the sandbox" } }, "referenced_sandbox_name": { "type": "string", "description": "The name of the referenced sandbox" }, "days": { "type": "integer", "description": "The number of days for sandbox retention", "format": "int32" }, "referenced_action_id": { "type": "integer", "description": "The ID of the referenced action", "format": "int32" }, "referenced_action_name": { "type": "string", "description": "The name of the referenced action" }, "sandbox_name": { "type": "string", "description": "The name of the sandbox" }, "snapshot_name": { "type": "string", "description": "The name of the snapshot" }, "snapshot_id": { "type": "string", "description": "The ID of the snapshot" }, "sandbox_distribution": { "type": "string", "description": "The distribution used for the sandbox" }, "resources": { "type": "string", "description": "The resource allocation for the sandbox", "enum": [ "1x2", "2x4", "3x6", "4x8", "5x10", "6x12", "7x14", "8x16", "9x18", "10x20", "11x22", "12x24", "CUSTOM" ] }, "return_existing": { "type": "boolean", "description": "If set to `true`, an existing sandbox will be returned" } } }, "SandboxCreateNewActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "sandbox_id": { "type": "string", "description": "The ID of the sandbox" }, "sandbox_references": { "uniqueItems": true, "type": "array", "description": "The set of sandbox reference types", "items": { "type": "string", "description": "The set of sandbox reference types", "enum": [ "BY_ID", "BY_TAGS", "BY_ACTION", "BY_NAME", "BY_PROJECT", "BY_DAYS" ] } }, "sandbox_project_id": { "type": "integer", "description": "The ID of the sandbox project", "format": "int32" }, "sandbox_project_name": { "type": "string", "description": "The name of the sandbox project" }, "tags": { "uniqueItems": true, "type": "array", "description": "The set of tags for the sandbox", "items": { "type": "string", "description": "The set of tags for the sandbox" } }, "referenced_sandbox_name": { "type": "string", "description": "The name of the referenced sandbox" }, "days": { "type": "integer", "description": "The number of days for sandbox retention", "format": "int32" }, "referenced_action_id": { "type": "integer", "description": "The ID of the referenced action", "format": "int32" }, "referenced_action_name": { "type": "string", "description": "The name of the referenced action" }, "sandbox_name": { "type": "string", "description": "The name of the sandbox" }, "snapshot_name": { "type": "string", "description": "The name of the snapshot" }, "snapshot_id": { "type": "string", "description": "The ID of the snapshot" }, "sandbox_distribution": { "type": "string", "description": "The distribution used for the sandbox" }, "resources": { "type": "string", "description": "The resource allocation for the sandbox", "enum": [ "1x2", "2x4", "3x6", "4x8", "5x10", "6x12", "7x14", "8x16", "9x18", "10x20", "11x22", "12x24", "CUSTOM" ] }, "return_existing": { "type": "boolean", "description": "If set to `true`, an existing sandbox will be returned" } } }, "SandboxDeleteActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "sandbox_id": { "type": "string", "description": "The ID of the sandbox" }, "sandbox_references": { "uniqueItems": true, "type": "array", "description": "The set of sandbox reference types", "items": { "type": "string", "description": "The set of sandbox reference types", "enum": [ "BY_ID", "BY_TAGS", "BY_ACTION", "BY_NAME", "BY_PROJECT", "BY_DAYS" ] } }, "sandbox_project_id": { "type": "integer", "description": "The ID of the sandbox project", "format": "int32" }, "sandbox_project_name": { "type": "string", "description": "The name of the sandbox project" }, "tags": { "uniqueItems": true, "type": "array", "description": "The set of tags for the sandbox", "items": { "type": "string", "description": "The set of tags for the sandbox" } }, "referenced_sandbox_name": { "type": "string", "description": "The name of the referenced sandbox" }, "days": { "type": "integer", "description": "The number of days for sandbox retention", "format": "int32" }, "referenced_action_id": { "type": "integer", "description": "The ID of the referenced action", "format": "int32" }, "referenced_action_name": { "type": "string", "description": "The name of the referenced action" }, "sandbox_name": { "type": "string", "description": "The name of the sandbox" }, "snapshot_name": { "type": "string", "description": "The name of the snapshot" }, "snapshot_id": { "type": "string", "description": "The ID of the snapshot" }, "sandbox_distribution": { "type": "string", "description": "The distribution used for the sandbox" }, "resources": { "type": "string", "description": "The resource allocation for the sandbox", "enum": [ "1x2", "2x4", "3x6", "4x8", "5x10", "6x12", "7x14", "8x16", "9x18", "10x20", "11x22", "12x24", "CUSTOM" ] }, "return_existing": { "type": "boolean", "description": "If set to `true`, an existing sandbox will be returned" } } }, "SandboxExecActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "sandbox_id": { "type": "string", "description": "The ID of the sandbox where commands are executed" }, "sandbox_references": { "uniqueItems": true, "type": "array", "description": "The set of sandbox reference types", "items": { "type": "string", "description": "The set of sandbox reference types", "enum": [ "BY_ID", "BY_TAGS", "BY_ACTION", "BY_NAME", "BY_PROJECT", "BY_DAYS" ] } }, "sandbox_project_id": { "type": "integer", "description": "The ID of the sandbox project", "format": "int32" }, "sandbox_project_name": { "type": "string", "description": "The name of the sandbox project" }, "tags": { "uniqueItems": true, "type": "array", "description": "The set of tags for the sandbox", "items": { "type": "string", "description": "The set of tags for the sandbox" } }, "referenced_sandbox_name": { "type": "string", "description": "The name of the referenced sandbox" }, "days": { "type": "integer", "description": "The number of days for sandbox retention", "format": "int32" }, "referenced_action_id": { "type": "integer", "description": "The ID of the referenced action", "format": "int32" }, "referenced_action_name": { "type": "string", "description": "The name of the referenced action" }, "working_directory": { "type": "string", "description": "The working directory for the command execution" }, "commands": { "type": "array", "description": "The commands to execute in the sandbox", "items": { "type": "string", "description": "The commands to execute in the sandbox" } }, "shell": { "type": "string", "description": "The shell to use for command execution" }, "execute_every_command": { "type": "boolean", "description": "Execute every command separately" }, "user": { "type": "string", "description": "The user to execute commands as" } } }, "SandboxSnapshotActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "sandbox_id": { "type": "string", "description": "The ID of the sandbox" }, "sandbox_references": { "uniqueItems": true, "type": "array", "description": "The set of sandbox reference types", "items": { "type": "string", "description": "The set of sandbox reference types", "enum": [ "BY_ID", "BY_TAGS", "BY_ACTION", "BY_NAME", "BY_PROJECT", "BY_DAYS" ] } }, "sandbox_project_id": { "type": "integer", "description": "The ID of the sandbox project", "format": "int32" }, "sandbox_project_name": { "type": "string", "description": "The name of the sandbox project" }, "tags": { "uniqueItems": true, "type": "array", "description": "The set of tags for the sandbox", "items": { "type": "string", "description": "The set of tags for the sandbox" } }, "referenced_sandbox_name": { "type": "string", "description": "The name of the referenced sandbox" }, "days": { "type": "integer", "description": "The number of days for sandbox retention", "format": "int32" }, "referenced_action_id": { "type": "integer", "description": "The ID of the referenced action", "format": "int32" }, "referenced_action_name": { "type": "string", "description": "The name of the referenced action" }, "sandbox_name": { "type": "string", "description": "The name of the sandbox" }, "snapshot_name": { "type": "string", "description": "The name of the snapshot" }, "snapshot_id": { "type": "string", "description": "The ID of the snapshot" }, "sandbox_distribution": { "type": "string", "description": "The distribution used for the sandbox" }, "resources": { "type": "string", "description": "The resource allocation for the sandbox", "enum": [ "1x2", "2x4", "3x6", "4x8", "5x10", "6x12", "7x14", "8x16", "9x18", "10x20", "11x22", "12x24", "CUSTOM" ] }, "return_existing": { "type": "boolean", "description": "If set to `true`, an existing sandbox will be returned" } } }, "SandboxStartActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "sandbox_id": { "type": "string", "description": "The ID of the sandbox" }, "sandbox_references": { "uniqueItems": true, "type": "array", "description": "The set of sandbox reference types", "items": { "type": "string", "description": "The set of sandbox reference types", "enum": [ "BY_ID", "BY_TAGS", "BY_ACTION", "BY_NAME", "BY_PROJECT", "BY_DAYS" ] } }, "sandbox_project_id": { "type": "integer", "description": "The ID of the sandbox project", "format": "int32" }, "sandbox_project_name": { "type": "string", "description": "The name of the sandbox project" }, "tags": { "uniqueItems": true, "type": "array", "description": "The set of tags for the sandbox", "items": { "type": "string", "description": "The set of tags for the sandbox" } }, "referenced_sandbox_name": { "type": "string", "description": "The name of the referenced sandbox" }, "days": { "type": "integer", "description": "The number of days for sandbox retention", "format": "int32" }, "referenced_action_id": { "type": "integer", "description": "The ID of the referenced action", "format": "int32" }, "referenced_action_name": { "type": "string", "description": "The name of the referenced action" }, "sandbox_name": { "type": "string", "description": "The name of the sandbox" }, "snapshot_name": { "type": "string", "description": "The name of the snapshot" }, "snapshot_id": { "type": "string", "description": "The ID of the snapshot" }, "sandbox_distribution": { "type": "string", "description": "The distribution used for the sandbox" }, "resources": { "type": "string", "description": "The resource allocation for the sandbox", "enum": [ "1x2", "2x4", "3x6", "4x8", "5x10", "6x12", "7x14", "8x16", "9x18", "10x20", "11x22", "12x24", "CUSTOM" ] }, "return_existing": { "type": "boolean", "description": "If set to `true`, an existing sandbox will be returned" } } }, "SandboxStopActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "sandbox_id": { "type": "string", "description": "The ID of the sandbox" }, "sandbox_references": { "uniqueItems": true, "type": "array", "description": "The set of sandbox reference types", "items": { "type": "string", "description": "The set of sandbox reference types", "enum": [ "BY_ID", "BY_TAGS", "BY_ACTION", "BY_NAME", "BY_PROJECT", "BY_DAYS" ] } }, "sandbox_project_id": { "type": "integer", "description": "The ID of the sandbox project", "format": "int32" }, "sandbox_project_name": { "type": "string", "description": "The name of the sandbox project" }, "tags": { "uniqueItems": true, "type": "array", "description": "The set of tags for the sandbox", "items": { "type": "string", "description": "The set of tags for the sandbox" } }, "referenced_sandbox_name": { "type": "string", "description": "The name of the referenced sandbox" }, "days": { "type": "integer", "description": "The number of days for sandbox retention", "format": "int32" }, "referenced_action_id": { "type": "integer", "description": "The ID of the referenced action", "format": "int32" }, "referenced_action_name": { "type": "string", "description": "The name of the referenced action" }, "sandbox_name": { "type": "string", "description": "The name of the sandbox" }, "snapshot_name": { "type": "string", "description": "The name of the snapshot" }, "snapshot_id": { "type": "string", "description": "The ID of the snapshot" }, "sandbox_distribution": { "type": "string", "description": "The distribution used for the sandbox" }, "resources": { "type": "string", "description": "The resource allocation for the sandbox", "enum": [ "1x2", "2x4", "3x6", "4x8", "5x10", "6x12", "7x14", "8x16", "9x18", "10x20", "11x22", "12x24", "CUSTOM" ] }, "return_existing": { "type": "boolean", "description": "If set to `true`, an existing sandbox will be returned" } } }, "SentryActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "projects": { "type": "array", "description": "The list of Sentry project slugs", "items": { "type": "string", "description": "The list of Sentry project slugs" } }, "version": { "type": "string", "description": "The version of the release" }, "environment": { "type": "string", "description": "The environment for the release" }, "release_url": { "type": "string", "description": "The URL for the release" }, "deploy_url": { "type": "string", "description": "The URL for the deployment" }, "organization_slug": { "type": "string", "description": "The Sentry organization slug" }, "repository": { "type": "string", "description": "The repository name" } } }, "SetVariablesActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "comment": { "type": "string", "description": "The comment for the wait action" }, "description": { "type": "string", "description": "The description of the wait action" }, "prevent_self_approval": { "type": "boolean", "description": "If set to `true`, the approver must be different from the person who triggered the run. Default: `false`." } } }, "ShopifyActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "local_path": { "type": "string", "description": "The path to the local files to deploy" }, "remote_path": { "type": "string", "description": "The path on the remote server where files will be deployed" }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "deployment_includes": { "type": "array", "description": "The list of files or directories to include in deployment", "items": { "type": "string", "description": "The list of files or directories to include in deployment" } }, "input_type": { "type": "string", "description": "The type of source input", "enum": [ "SCM_REPOSITORY", "BUILD_ARTIFACTS" ] }, "deletion_disabled": { "type": "boolean", "description": "If set to `true`, files on the remote server will not be deleted" }, "use_temporary_files": { "type": "boolean", "description": "If set to `true`, files will be uploaded to a temporary directory first" }, "content_encoding": { "type": "string", "description": "The content encoding for deployed files" }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "theme": { "type": "string", "description": "The name of the Shopify theme" } } }, "ShopifyCliActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" } } }, "ShopifyThemekitActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "theme": { "type": "string", "description": "The name of the Shopify theme" } } }, "SlackActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "channel": { "type": "string", "description": "The Slack channel name or ID" }, "content": { "type": "string", "description": "The message content to send" }, "attachments": { "type": "array", "description": "The list of attachment URLs", "items": { "type": "string", "description": "The list of attachment URLs" } }, "file_attachments": { "type": "array", "description": "The list of file attachment paths", "items": { "type": "string", "description": "The list of file attachment paths" } }, "blocks": { "type": "string", "description": "The Slack blocks JSON for rich formatting" } } }, "SleepActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "sleep_in_sec": { "type": "integer", "description": "The duration to sleep in seconds", "format": "int32" } } }, "SmsActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "content": { "type": "string", "description": "The SMS message content" }, "recipients": { "type": "string", "description": "The phone numbers to send the SMS to" } } }, "SnykActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "version": { "type": "string", "description": "The version of Snyk CLI to use" } } }, "SplitTestsActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "source_path": { "type": "string", "description": "The path to the test files" }, "groups_count": { "type": "integer", "description": "The number of groups to split tests into", "format": "int32" }, "files_order": { "type": "string", "description": "The order in which test files should be sorted", "enum": [ "alphabetically", "size" ] } } }, "SshCommandActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "working_directory": { "type": "string", "description": "The working directory for command execution" }, "commands": { "type": "array", "description": "The commands to execute via SSH", "items": { "type": "string", "description": "The commands to execute via SSH" } }, "shell": { "type": "string", "description": "The shell to use for command execution" }, "execute_every_command": { "type": "boolean", "description": "Execute every command separately" }, "run_as_script": { "type": "boolean", "description": "Run commands as a script file" }, "targets": { "type": "array", "description": "The list of target servers for SSH command execution", "items": { "$ref": "#/components/schemas/TargetView" } } } }, "SslVerifyActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "website": { "type": "string", "description": "The website URL to verify SSL certificate for" }, "port": { "type": "string", "description": "The port to use for SSL verification" }, "valid_for_days": { "type": "integer", "description": "The minimum number of days the certificate should be valid for", "format": "int32" } } }, "StackHawkActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" } } }, "StorybookActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "working_directory": { "type": "string", "description": "The directory in which the pipeline filesystem will be mounted" }, "main_service_name": { "type": "string", "description": "The hostname of the container in which the action is run. The container will be available under this name in the docker network for services" }, "run_as_user": { "type": "string", "description": "All build commands are run as the default user defined in the selected Docker image. Can be set to another username (on the condition that this user exists in the selected image)" }, "version": { "type": "string", "description": "The version of the artifact from artifact registry" }, "docker_image_name": { "type": "string", "description": "The name of the Docker image" }, "docker_image_tag": { "type": "string", "description": "The tag of the Docker image" }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "mount_filesystem_disable": { "type": "boolean", "description": "If set to `true`, the filesystem will not be mounted in the container" }, "volume_mappings": { "type": "array", "description": "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)", "items": { "type": "string", "description": "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)" } }, "cached_dirs": { "type": "array", "description": "The dependencies & directories to be cached and available to every execution in this pipeline", "items": { "type": "string", "description": "The dependencies & directories to be cached and available to every execution in this pipeline" } }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "services": { "type": "array", "description": "The list of services attached to the build environment", "items": { "$ref": "#/components/schemas/ServiceView" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "registry": { "type": "string", "description": "The URL of the Docker registry" }, "insecure_registry": { "type": "boolean", "description": "If set to `true`, the registry will be accessed over HTTP instead of HTTPS" }, "login": { "type": "string", "description": "The username for the Docker registry" }, "target_stage": { "type": "string", "description": "The target stage of the Dockerfile" }, "password": { "type": "string", "description": "The password for the Docker registry" }, "region": { "type": "string", "description": "The region for the Docker registry (for AWS ECR)" }, "image_location": { "type": "string", "description": "The location of the image used by the action", "enum": [ "PUBLIC_REGISTRY", "PRIVATE_REGISTRY", "ACTION", "ARTIFACT_REGISTRY" ] }, "docker_registry": { "type": "string", "description": "The type of registry from which the image is retrieved", "enum": [ "NONE", "DOCKER_HUB", "AMAZON_ECR", "GOOGLE_GCR", "GOOGLE_ARTIFACT_REGISTRY", "OTHER", "GIT_HUB_CONTAINER_REGISTRY", "ARTIFACT_REGISTRY", "DIGITAL_OCEAN_CONTAINER_REGISTRY" ] }, "docker_build_action_id": { "type": "integer", "description": "The ID of the action from which the Docker image will be used", "format": "int32" }, "docker_build_action_name": { "type": "string", "description": "The name of the action from which the Docker image will be used" }, "export_container_path": { "type": "string", "description": "The path in the container to export" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "ignore_image_pull_failures": { "type": "boolean", "description": "If set to `true`, use cached image on timeouts (only for official images)" }, "cache_base_image": { "type": "boolean", "description": "If set to `true`, the cached version of the image is used, instead of being pulled each time" }, "reset_entrypoint": { "type": "boolean", "description": "If set to `true`, resets the default entrypoint set by the image. Default value: `false`" }, "vt_suite": { "type": "string", "description": "The visual tests suite identifier" }, "unit_tests_suite": { "type": "string", "description": "The unit tests suite identifier" }, "unit_tests_path": { "type": "string", "description": "The path to the unit tests results" }, "artifact": { "type": "string", "description": "The identifier of the artifact from artifact registry" } } }, "TcpActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "destination": { "type": "string", "description": "The destination host or IP address" }, "port": { "type": "string", "description": "The TCP port number to connect to" }, "text": { "type": "string", "description": "The text to search for in the response" }, "post_data": { "type": "string", "description": "The data to send to the TCP server" } } }, "TelegramActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "content": { "type": "string", "description": "The message content to send" }, "parse_mode": { "type": "string", "description": "The parsing mode for the message", "enum": [ "PLAIN_TEXT", "MARKDOWN", "HTML" ] }, "file_attachments": { "type": "array", "description": "The list of file attachment paths", "items": { "type": "string", "description": "The list of file attachment paths" } } } }, "TerraformActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "region": { "type": "string", "description": "The cloud provider region for Terraform resources" }, "server_key": { "type": "string", "description": "The server key for Terraform backend" }, "version": { "type": "string", "description": "The version of Terraform to use" }, "backend": { "type": "string", "description": "The Terraform backend configuration", "enum": [ "CUSTOM", "AMAZON", "GOOGLE" ] } } }, "TransferActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "local_path": { "type": "string", "description": "The path to the local files to deploy" }, "remote_path": { "type": "string", "description": "The path on the remote server where files will be deployed" }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "deployment_includes": { "type": "array", "description": "The list of files or directories to include in deployment", "items": { "type": "string", "description": "The list of files or directories to include in deployment" } }, "input_type": { "type": "string", "description": "The type of source input", "enum": [ "SCM_REPOSITORY", "BUILD_ARTIFACTS" ] }, "deletion_disabled": { "type": "boolean", "description": "If set to `true`, files on the remote server will not be deleted" }, "use_temporary_files": { "type": "boolean", "description": "If set to `true`, files will be uploaded to a temporary directory first" }, "content_encoding": { "type": "string", "description": "The content encoding for deployed files" }, "compress": { "type": "boolean", "description": "Enable file compression during ssh transfer" }, "targets": { "type": "array", "description": "The list of target servers for file transfer", "items": { "$ref": "#/components/schemas/TargetView" } } } }, "TrivyCliActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "version": { "type": "string", "description": "The version of the Trivy image to use. Default: `latest`" } } }, "VisualTest2ActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "vt_suite": { "type": "string", "description": "The visual test suite identifier" }, "urls": { "type": "array", "description": "URLs to compare (comma separated list, e.g., `https://example.com,https://example.org`)", "items": { "type": "string", "description": "URLs to compare (comma separated list, e.g., `https://example.com,https://example.org`)" } }, "sitemap": { "type": "string", "description": "URL from which sitemap will be gathered" }, "urls_file": { "type": "string", "description": "File with URLs to compare" }, "ignore_urls": { "type": "array", "description": "Ignore URLs matching the regex pattern", "items": { "type": "string", "description": "Ignore URLs matching the regex pattern" } }, "follow": { "type": "boolean", "description": "Scrap all subviews of the page. Default: false" }, "respect_robots": { "type": "boolean", "description": "Respect robots.txt. Default: false" }, "ignores": { "type": "array", "description": "Ignore elements matching selectors while comparing (format: [scope::]type=value, e.g., \"CSS=.ad-banner\" or \"XPATH=//div[@id='popup']\" or \"example.com::CSS=.cookie-notice\")", "items": { "type": "string", "description": "Ignore elements matching selectors while comparing (format: [scope::]type=value, e.g., \"CSS=.ad-banner\" or \"XPATH=//div[@id='popup']\" or \"example.com::CSS=.cookie-notice\")" } }, "delays": { "type": "array", "description": "Add delay in milliseconds before taking screenshot (format: [scope::]milliseconds, e.g., \"1000\" or \"example.com::2000\")", "items": { "type": "string", "description": "Add delay in milliseconds before taking screenshot (format: [scope::]milliseconds, e.g., \"1000\" or \"example.com::2000\")" } }, "wait_for": { "type": "array", "description": "Wait for elements to appear before taking screenshot (format: [scope::]type=value, e.g., \"CSS=#content\" or \"example.com::XPATH=//div[@class='loaded']\")", "items": { "type": "string", "description": "Wait for elements to appear before taking screenshot (format: [scope::]type=value, e.g., \"CSS=#content\" or \"example.com::XPATH=//div[@class='loaded']\")" } }, "cookies": { "type": "array", "description": "Set cookies used when visiting the URLs (format: [scope::]cookie_value, e.g., \"session=abc123\" or \"example.com::auth=token123; Path=/; Secure; HttpOnly\")", "items": { "type": "string", "description": "Set cookies used when visiting the URLs (format: [scope::]cookie_value, e.g., \"session=abc123\" or \"example.com::auth=token123; Path=/; Secure; HttpOnly\")" } }, "headers": { "type": "array", "description": "Set HTTP headers used when visiting the URLs (format: [scope::]name=value, e.g., \"Authorization=Bearer token\" or \"example.com::Accept=application/json\")", "items": { "type": "string", "description": "Set HTTP headers used when visiting the URLs (format: [scope::]name=value, e.g., \"Authorization=Bearer token\" or \"example.com::Accept=application/json\")" } } } }, "VisualTestsActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "resolution_width": { "type": "integer", "description": "The width of the browser viewport in pixels", "format": "int32" }, "resolution_height": { "type": "integer", "description": "The height of the browser viewport in pixels", "format": "int32" }, "pixel_tolerance_level": { "type": "number", "description": "The tolerance level for pixel differences (0.0 to 1.0)", "format": "double" }, "images_history_limit": { "type": "integer", "description": "The maximum number of historical images to keep", "format": "int32" }, "headers": { "type": "array", "description": "The HTTP headers to include in requests", "items": { "$ref": "#/components/schemas/HeaderView" } }, "screenshots": { "type": "array", "description": "The list of screenshots to capture and compare", "items": { "$ref": "#/components/schemas/ScreenshotView" } } } }, "WaitForApplyActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "comment": { "type": "string", "description": "The comment for the wait action" }, "description": { "type": "string", "description": "The description of the wait action" }, "prevent_self_approval": { "type": "boolean", "description": "If set to `true`, the approver must be different from the person who triggered the run. Default: `false`." } } }, "WaitForVariablesActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "comment": { "type": "string", "description": "The comment for the wait action" }, "description": { "type": "string", "description": "The description of the wait action" }, "prevent_self_approval": { "type": "boolean", "description": "If set to `true`, the approver must be different from the person who triggered the run. Default: `false`." } } }, "WebActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "destination": { "type": "string", "description": "The destination URL to test" }, "port": { "type": "string", "description": "The port number for the HTTP request" }, "login": { "type": "string", "description": "The login username for HTTP authentication" }, "password": { "type": "string", "description": "The password for HTTP authentication" }, "headers": { "type": "array", "description": "The HTTP headers to include in the request", "items": { "$ref": "#/components/schemas/HeaderView" } }, "post_data": { "type": "string", "description": "The POST data to send with the request" }, "text": { "type": "string", "description": "The text to search for in the response" }, "text_existence": { "type": "boolean", "description": "If set to `true`, the action will succeed if the text is found; if `false`, it will succeed if the text is not found" } } }, "WebDavActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "local_path": { "type": "string", "description": "The path to the local files to deploy" }, "remote_path": { "type": "string", "description": "The path on the remote server where files will be deployed" }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "deployment_includes": { "type": "array", "description": "The list of files or directories to include in deployment", "items": { "type": "string", "description": "The list of files or directories to include in deployment" } }, "input_type": { "type": "string", "description": "The type of source input", "enum": [ "SCM_REPOSITORY", "BUILD_ARTIFACTS" ] }, "deletion_disabled": { "type": "boolean", "description": "If set to `true`, files on the remote server will not be deleted" }, "use_temporary_files": { "type": "boolean", "description": "If set to `true`, files will be uploaded to a temporary directory first" }, "content_encoding": { "type": "string", "description": "The content encoding for deployed files" }, "web_dav_url": { "type": "string", "description": "The WebDAV server URL" }, "login": { "type": "string", "description": "The login username for WebDAV authentication" }, "password": { "type": "string", "description": "The password for WebDAV authentication" } } }, "WindowsNativeBuildActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "working_directory": { "type": "string", "description": "The directory in which the pipeline filesystem will be mounted" }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "commands": { "type": "array", "description": "The commands to execute in the native build environment", "items": { "type": "string", "description": "The commands to execute in the native build environment" } }, "deployment_excludes": { "type": "array", "description": "The list of files or directories to exclude from deployment", "items": { "type": "string", "description": "The list of files or directories to exclude from deployment" } }, "vm_from_prev_action": { "type": "boolean", "description": "If set to `true`, the VM from the previous action will be used" }, "vm_action_id": { "type": "integer", "description": "The ID of the action from which the VM will be used", "format": "int32" }, "vm_action_name": { "type": "string", "description": "The name of the action from which the VM will be used" }, "instance_type": { "type": "string", "description": "The type of instance to use for the native build", "enum": [ "GENERAL_MEDIUM", "GENERAL_LARGE", "GENERAL_XLARGE", "GENERAL_2XLARGE", "COMPUTE_MEDIUM", "COMPUTE_LARGE", "COMPUTE_XLARGE", "COMPUTE_2XLARGE", "ARM_GENERAL_MEDIUM", "ARM_GENERAL_LARGE", "ARM_GENERAL_XLARGE", "ARM_GENERAL_2XLARGE", "ARM_COMPUTE_MEDIUM", "ARM_COMPUTE_LARGE", "ARM_COMPUTE_XLARGE", "ARM_COMPUTE_2XLARGE" ] }, "sync_paths": { "type": "array", "description": "The list of paths to synchronize", "items": { "$ref": "#/components/schemas/SyncPathView" } }, "distribution": { "type": "string", "description": "The AWS distribution type", "enum": [ "UBUNTU_20_04", "AMI", "WINDOWS_SERVER_2019", "PREVIOUS_ACTION" ] }, "ami": { "$ref": "#/components/schemas/AmiView" } } }, "WpCliActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "shell": { "type": "string", "description": "The name of the shell that will be used to execute commands", "enum": [ "SH", "BASH", "POWERSHELL" ] }, "setup_commands": { "type": "array", "description": "The command that will be executed only on the first run", "items": { "type": "string", "description": "The command that will be executed only on the first run" } }, "execute_commands": { "type": "array", "description": "The commands that will be executed", "items": { "type": "string", "description": "The commands that will be executed" } }, "execute_every_command": { "type": "boolean", "description": "If set to `true` all commands will be executed regardless of the result of the previous command" }, "config": { "type": "string", "description": "The WP-CLI configuration options" }, "env_key": { "type": "string", "description": "The environment key for WordPress configuration" }, "version": { "type": "string", "description": "The WP-CLI version to use" } } }, "ZipActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "loop": { "type": "array", "description": "The list of commands that will be executed in a loop", "items": { "type": "string", "description": "The list of commands that will be executed in a loop" } }, "local_path": { "type": "string", "description": "The local path to the files to compress" }, "destination": { "type": "string", "description": "The destination path for the ZIP archive" }, "deployment_excludes": { "type": "array", "description": "The list of file patterns to exclude from the ZIP archive", "items": { "type": "string", "description": "The list of file patterns to exclude from the ZIP archive" } }, "deployment_includes": { "type": "array", "description": "The list of file patterns to include in the ZIP archive", "items": { "type": "string", "description": "The list of file patterns to include in the ZIP archive" } } } }, "ActionsView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/ShortActionResponse" } } } }, "ShortActionResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" }, "name": { "type": "string", "description": "The name of the action" }, "type": { "type": "string", "description": "The type of the action", "enum": [ "TRANSFER", "AMAZON_S3", "WEB_DAV", "SSH_COMMAND", "HTTP", "SLACK", "EMAIL", "SMS", "PUSH", "HEROKU", "BUILD", "PING", "WEB", "TCP", "RUN_NEXT_PIPELINE", "ELASTIC_BEANSTALK", "GCS", "SHOPIFY", "PUSHOVER", "PUSHBULLET", "CODE_DEPLOY", "AZURE", "DOCKERFILE", "GOOGLE_APP_ENGINE", "LAMBDA", "HEROKU_CLI", "RACKSPACE", "CLOUDFLARE", "CLOUD_FRONT", "MONITOR", "SLEEP", "AWS_CLI", "GOOGLE_CDN", "AWS_LAMBDA_DEPLOY", "KUBERNETES_APPLY", "KUBERNETES_SET_IMAGE", "KUBERNETES_RUN_POD", "WAIT_FOR_APPLY", "APPROVE_VT", "NEW_RELIC", "KUBERNETES_RUN_JOB", "ZIP", "ROLLBAR", "SENTRY", "DATADOG", "DO_SPACES", "HONEYBADGER", "SENTRY_ENTERPRISE", "LOGGLY", "KUBERNETES_CLI", "RUN_DOCKER_CONTAINER", "ESLINT", "DOCKER_PUSH", "ANDROID_SIGN", "ANDROID_PLAY", "WAIT_FOR_VARIABLES", "GCLOUD_CLI", "AWS_ECS", "COPY_FILES", "FIREBASE", "TELEGRAM", "REPLACE", "GOOGLE_FUNCTIONS_DEPLOY", "GOOGLE_FUNCTIONS", "BUGSNAG", "SPLIT_TESTS", "RAYGUN", "DATADOG_STATUS_CHECK", "GHOST_INSPECTOR", "AWS_CLOUD_FORMATION", "DIGITAL_OCEAN_CDN", "DISCORD2", "IMAGE_COMPRESSION", "NETLIFY", "GIT_CRYPT_UNLOCK", "GIT_CRYPT_LOCK", "HELM", "DOCKERFILE_LINTER", "DOWNLOAD", "DOWNLOAD_S3", "LIGHTHOUSE", "ANDROID_SIGN_BUNDLE", "ANDROID_PLAY_BUNDLE", "VISUAL_TESTS", "VISUAL_TEST_2", "LINK_VALIDATOR", "AZURE_CLI", "SHOPIFY_THEMEKIT_CLI", "SSL_VERIFY", "AZURE_STORAGE", "DEPLOY_TO_SANDBOX", "SANDBOX_START", "SANDBOX_STOP", "SANDBOX_EXEC", "GIT_HUB_RELEASE", "GCLOUD_RUN_DEPLOY", "SANDBOX_SNAPSHOT", "AWS_CLI_2", "MICROSOFT_TEAMS", "NATIVE_BUILD_WINDOWS", "NATIVE_BUILD_MAC", "DOCTL", "NATIVE_BUILD_MAC_REACT", "NATIVE_BUILD_MAC_CORDOVA", "NATIVE_BUILD_MAC_FASTLANE", "NATIVE_BUILD_MAC_FLUTTER", "GOOGLE_CLOUD_STORAGE", "GOOGLE_FUNCTION_DEPLOY", "GOOGLE_FUNCTION_INVOKE", "GOOGLE_CDN_INVALIDATE", "GOOGLE_CLOUD_CLI", "GOOGLE_CLOUD_RUN_DEPLOY", "GOOGLE_APP_DEPLOY", "ANDROID_PUBLISH_APK", "ANDROID_PUBLISH_APP_BUNDLE", "SANDBOX_CREATE_NEW", "SANDBOX_CREATE_FROM_SANDBOX", "SANDBOX_CREATE_FROM_SNAPSHOT", "SANDBOX_DELETE", "NATIVE_BUILD_MAC_SIGN", "NATIVE_BUILD_MAC_DEPLOY", "NATIVE_BUILD_DOCKER_CLI", "CLEAR_CACHE", "FASTLANE_ANDROID", "NATIVE_BUILD_LINUX", "GIT_HUB_CLI", "INTEGRATION_VARIABLES", "DOCKER_BUILD_MULTI_ARCH", "CODE_PIPELINE", "GIT_LAB_CLI", "AWS_APP_RUNNER_DEPLOY", "AWS_APP_RUNNER_MONITOR", "NATIVE_BUILD_MAC_VM", "AWS_CDK_CLI", "GHOST_INSPECTOR_CLI", "TERRAFORM", "ATOP", "SNYK_CLI", "STACK_HAWK_CLI", "JMETER_CLI", "CUSTOM", "BLACKFIRE_PHP", "BLACKFIRE_PYTHON", "BLACKFIRE_GO", "LINK_CHECKER", "SHOPIFY_CLI", "DOCKER", "SET_VARIABLES", "DOWNLOAD_FROM_SANDBOX", "PIPELINE_SETTINGS", "BACKBLAZE_B2", "NEW_RELIC_CLI", "DOWNLOAD_GCS", "DOWNLOAD_BACKBLAZE_B2", "WP_CLI", "GOOGLE_CHAT", "SANDBOX_APPLICATION_START", "SANDBOX_APPLICATION_STOP", "POWERSHELL", "SANDBOX_MANAGE", "SANDBOX_CREATE", "CONTENTFUL_CLI", "JIRA_BUILD", "JIRA_DEPLOYMENT", "MYSQL_CLI", "POSTGRESQL_CLI", "MONGOSH_CLI", "MSSQL_CLI", "CRAWL", "FTP", "FTPS", "SFTP", "GCE", "VULTR", "UPCLOUD", "DIGITAL_OCEAN", "DOWNLOAD_FTP", "DOWNLOAD_FTPS", "DOWNLOAD_SSH", "RSYNC", "PROMOTE_IMAGE", "PUBLISH_ARTIFACT_VERSION", "DOWNLOAD_ARTIFACT_VERSION", "STORYBOOK", "PLAYWRIGHT", "CYPRESS", "NPM_PUBLISH", "GIT_MERGE", "TRIVY_CLI", "CLAUDE_CODE" ] }, "current_revision": { "type": "string", "description": "The git revision of the last successful run of the action" }, "trigger_time": { "type": "string", "description": "Specifies when the action should be executed", "enum": [ "ON_EVERY_EXECUTION", "ON_SUCCESS", "ON_FAILURE", "ON_BACK_TO_SUCCESS", "ON_WARNING", "ON_WAIT_FOR_APPROVE", "ON_TERMINATE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the action can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "run_next": { "type": "string", "description": "Defines whether the action should run in parallel with the next one", "enum": [ "WAIT_ON_SUCCESS", "IN_SOFT_PARALLEL", "IN_HARD_PARALLEL" ] }, "run_only_on_first_failure": { "type": "boolean", "description": "Defines whether the action should be executed on each failure. Restricted to and required if the `trigger_time` is `ON_FAILURE`" }, "variables": { "type": "array", "description": "The list of variables you can use the action", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "disabled": { "type": "boolean", "description": "When set to `true` the action is disabled. By default it is set to `false`" }, "timeout": { "type": "integer", "description": "The timeout in seconds", "format": "int32" }, "ignore_errors": { "type": "boolean", "description": "If set to `true` the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions" }, "retry_count": { "type": "integer", "description": "Number of retries if the action fails", "format": "int32" }, "retry_interval": { "type": "integer", "description": "Delay time between auto retries in seconds", "format": "int32" }, "last_execution_status": { "type": "string", "description": "The status of the last run of the action", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" }, "helm_repository_integration": { "$ref": "#/components/schemas/IntegrationIdentifierView" } } }, "BranchView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "name": { "type": "string", "description": "The name of the branch" }, "commit": { "$ref": "#/components/schemas/ShortCommitView" }, "description": { "type": "string", "description": "The description of the branch" }, "default": { "type": "boolean", "description": "Indicates whether this branch is default branch in the repository" } } }, "ShortCommitView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "revision": { "type": "string", "description": "The full SHA hash of the commit" }, "author_date": { "type": "string", "description": "The date when the commit was authored", "format": "date-time" }, "commit_date": { "type": "string", "description": "The date when the commit was committed", "format": "date-time" }, "short_revision": { "type": "string", "description": "The short SHA hash of the commit (first 7 characters)" }, "message": { "type": "string", "description": "The commit message" }, "committer": { "$ref": "#/components/schemas/MemberView" }, "author": { "$ref": "#/components/schemas/MemberView" } } }, "CommitReference": { "type": "object", "properties": { "revision": { "type": "string", "description": "The full SHA hash of the commit", "example": "506a3963507943d6908154f4bc9646e829128a08" } }, "description": "The commit containing the revision field" }, "CreateBranchRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "The name of the branch" }, "commit": { "$ref": "#/components/schemas/CommitReference" }, "description": { "type": "string", "description": "The description of the branch" } } }, "PipelineResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The unique ID of the pipeline", "format": "int32" }, "identifier": { "type": "string", "description": "A human-readable ID of pipeline" }, "name": { "type": "string", "description": "The name of the pipeline" }, "definition_source": { "type": "string", "description": "The source of the pipeline definition", "enum": [ "LOCAL", "REMOTE" ] }, "git_config_ref": { "type": "string", "description": "The git configuration reference type", "enum": [ "NONE", "DYNAMIC", "FIXED" ] }, "refs": { "type": "array", "description": "Pipeline git context refs. If unset and events is empty, the pipeline counts as codeless", "items": { "type": "string", "description": "Pipeline git context refs. If unset and events is empty, the pipeline counts as codeless" } }, "events": { "type": "array", "description": "The list of events that trigger the pipeline run", "items": { "$ref": "#/components/schemas/PipelineEventView" } }, "loop": { "uniqueItems": true, "type": "array", "description": "The loop configuration for the pipeline", "items": { "type": "string" } }, "priority": { "type": "string", "description": "The priority of the pipeline", "enum": [ "LOW", "NORMAL", "HIGH" ] }, "disabled": { "type": "boolean", "description": "Indicates if the pipeline is disabled" }, "disabled_reason": { "type": "string", "description": "The reason why the pipeline is disabled" }, "last_execution_status": { "type": "string", "description": "The status of the last run", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "last_execution_revision": { "type": "string", "description": "The git revision of the last run" }, "target_site_url": { "type": "string", "description": "The URL to the target site after deployment" }, "execution_message_template": { "type": "string", "description": "The template for commit status messages" }, "create_date": { "type": "string", "description": "The creation date of the pipeline", "format": "date-time" }, "always_from_scratch": { "type": "boolean", "description": "Defines whether to upload everything from scratch on every run" }, "ignore_fail_on_project_status": { "type": "boolean", "description": "If set to true, the status of a given pipeline will not impact the project status on the dashboard" }, "no_skip_to_most_recent": { "type": "boolean", "description": "If set to true, the pipeline will not skip queued runs to execute the most recent one" }, "terminate_stale_runs": { "type": "boolean", "description": "If set to true, stale runs will be automatically terminated" }, "auto_clear_cache": { "type": "boolean", "description": "Defines whether to automatically clear cache before running the pipeline" }, "paused": { "type": "boolean", "description": "Indicates if the pipeline is paused" }, "pause_on_repeated_failures": { "type": "integer", "description": "Defines how many repeated failures are required to pause the pipeline", "format": "int32" }, "fetch_all_refs": { "type": "boolean", "description": "If set to true, all refs will be fetched from the repository" }, "fetch_lfs": { "type": "boolean", "description": "If set to true, LFS files will be fetched from the external repository during pipeline runs" }, "fail_on_prepare_env_warning": { "type": "boolean", "description": "If set to true, the pipeline will fail on environment preparation warnings" }, "concurrent_pipeline_runs": { "type": "boolean", "description": "Defines whether the pipeline can be run concurrently" }, "clone_depth": { "type": "integer", "description": "Defines the depth of the git clone operation for shallow clones", "format": "int32" }, "do_not_create_commit_status": { "type": "boolean", "description": "If set to true, commit statuses will not be created in the repository" }, "stale": { "type": "boolean", "description": "Indicates that pipeline definition was probably removed on particular Git ref and pipeline won't be run on events" }, "waiting_for_push": { "type": "boolean", "description": "Indicates if the pipeline is waiting for the first push to the repository" }, "resources": { "type": "string", "description": "The resource configuration for the pipeline run", "enum": [ "DEFAULT", "NANO", "SMALL", "MEDIUM", "LARGE", "XLARGE", "CUSTOM", "X2LARGE" ] }, "remote_path": { "type": "string", "description": "The path to the remote pipeline definition file" }, "remote_ref": { "type": "string", "description": "The ref of the remote pipeline definition" }, "remote_project_name": { "type": "string", "description": "The project name of the remote pipeline definition" }, "remote_parameters": { "type": "array", "description": "The parameters passed to the remote pipeline definition", "items": { "$ref": "#/components/schemas/PipelinePropertyView" } }, "git_config": { "$ref": "#/components/schemas/YamlDefinitionView" }, "tags": { "uniqueItems": true, "type": "array", "description": "The list of tags associated with the pipeline for organization", "items": { "type": "string" } }, "git_changeset_base": { "type": "string", "description": "The base for git changeset calculation. Determines which changes trigger the pipeline", "enum": [ "LATEST_RUN", "LATEST_RUN_MATCHING_REF", "PULL_REQUEST" ] }, "filesystem_changeset_base": { "type": "string", "description": "The base for filesystem changeset calculation. Determines which file changes trigger the pipeline", "enum": [ "DATE_MODIFIED", "CONTENTS" ] }, "cpu": { "type": "string", "description": "The CPU architecture for the pipeline run", "enum": [ "X64", "ARM", "X86" ] }, "description_required": { "type": "boolean", "description": "If set to true, a description is required when executing the pipeline manually" }, "folder": { "type": "string", "description": "The folder name where the pipeline is organized" }, "project": { "$ref": "#/components/schemas/ShortProjectView" }, "creator": { "$ref": "#/components/schemas/MemberView" }, "cache_scope": { "type": "string", "description": "Defines the cache scope", "enum": [ "PIPELINE", "PROJECT", "WORKSPACE" ] }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the pipeline can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "variables": { "type": "array", "description": "The list of environment variables defined for the pipeline", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } }, "environments": { "type": "array", "description": "The list of environments attached to the pipeline", "items": { "$ref": "#/components/schemas/EnvironmentView" } }, "artifacts": { "type": "array", "description": "The list of artifact contexts configured for the pipeline", "items": { "$ref": "#/components/schemas/PipelineArtifactContextView" } }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "manage_variables_by_yaml": { "type": "boolean", "description": "If set to true, variables are managed by YAML configuration" }, "manage_permissions_by_yaml": { "type": "boolean", "description": "If set to true, permissions are managed by YAML configuration" }, "actions": { "type": "array", "description": "The list of actions configured in the pipeline", "items": { "$ref": "#/components/schemas/ShortActionResponse" } } } }, "ClonePipelineRequest": { "required": [ "source_pipeline_id" ], "type": "object", "properties": { "source_pipeline_id": { "type": "integer", "description": "The ID of the source pipeline to clone from", "format": "int32" }, "name": { "type": "string", "description": "The name of the pipeline" }, "identifier": { "type": "string", "description": "A human-readable ID of pipeline" } } }, "AddPipelineRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the pipeline" }, "identifier": { "type": "string", "description": "A human-readable ID. Alphanumeric characters, underscores, and hyphens (hyphens cannot appear at the start or end)." }, "refs": { "type": "array", "description": "Pipeline git context refs. If unset and events is empty, the pipeline counts as codeless", "items": { "type": "string" } }, "events": { "type": "array", "description": "The list of events that trigger the pipeline run", "items": { "$ref": "#/components/schemas/PipelineEventView" } }, "folder": { "type": "string", "description": "The folder name where the pipeline is organized" }, "priority": { "type": "string", "description": "The priority of the pipeline", "enum": [ "LOW", "NORMAL", "HIGH" ] }, "disabled": { "type": "boolean", "description": "Indicates if the pipeline is disabled" }, "disabled_reason": { "type": "string", "description": "The reason why the pipeline is disabled" }, "target_site_url": { "type": "string", "description": "The URL to the target site after deployment" }, "execution_message_template": { "type": "string", "description": "The template for commit status messages" }, "always_from_scratch": { "type": "boolean", "description": "Defines whether to upload everything from scratch on every run" }, "ignore_fail_on_project_status": { "type": "boolean", "description": "If set to true, the status of a given pipeline will not impact the project status on the dashboard" }, "no_skip_to_most_recent": { "type": "boolean", "description": "If set to true, the pipeline will not skip queued runs to execute the most recent one" }, "terminate_stale_runs": { "type": "boolean", "description": "If set to true, stale runs will be automatically terminated" }, "cache_scope": { "type": "string", "description": "Defines the cache scope", "enum": [ "PIPELINE", "PROJECT", "WORKSPACE" ] }, "auto_clear_cache": { "type": "boolean", "description": "Defines whether to automatically clear cache before running the pipeline" }, "pause_on_repeated_failures": { "type": "integer", "description": "Defines how many repeated failures are required to pause the pipeline", "format": "int32" }, "fetch_all_refs": { "type": "boolean", "description": "If set to true, all refs will be fetched from the repository" }, "fetch_lfs": { "type": "boolean", "description": "If set to true, LFS files will be fetched from the external repository during pipeline runs" }, "fail_on_prepare_env_warning": { "type": "boolean", "description": "If set to true, the pipeline will fail on environment preparation warnings" }, "concurrent_pipeline_runs": { "type": "boolean", "description": "Defines whether the pipeline can be run concurrently" }, "clone_depth": { "type": "integer", "description": "Defines the depth of the git clone operation for shallow clones", "format": "int32" }, "do_not_create_commit_status": { "type": "boolean", "description": "If set to true, commit statuses will not be created in the repository" }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the pipeline can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "variables": { "type": "array", "description": "The list of environment variables defined for the pipeline", "items": { "$ref": "#/components/schemas/AddVariableInObjectRequest" } }, "resources": { "type": "string", "description": "The resource configuration for the pipeline run", "enum": [ "DEFAULT", "NANO", "SMALL", "MEDIUM", "LARGE", "XLARGE", "CUSTOM", "X2LARGE" ] }, "git_changeset_base": { "type": "string", "description": "The base for git changeset calculation. Determines which changes trigger the pipeline", "enum": [ "LATEST_RUN", "LATEST_RUN_MATCHING_REF", "PULL_REQUEST" ] }, "filesystem_changeset_base": { "type": "string", "description": "The base for filesystem changeset calculation. Determines which file changes trigger the pipeline", "enum": [ "DATE_MODIFIED", "CONTENTS" ] }, "tags": { "uniqueItems": true, "type": "array", "description": "The list of tags associated with the pipeline for organization", "items": { "type": "string" } }, "cpu": { "type": "string", "description": "The CPU architecture for the pipeline run", "enum": [ "X64", "ARM", "X86" ] }, "description_required": { "type": "boolean", "description": "If set to true, a description is required when executing the pipeline manually" }, "manage_variables_by_yaml": { "type": "boolean", "description": "If set to true, variables are managed by YAML configuration" }, "manage_permissions_by_yaml": { "type": "boolean", "description": "If set to true, permissions are managed by YAML configuration" }, "environments": { "type": "array", "description": "The list of environments attached to the pipeline", "items": { "$ref": "#/components/schemas/EnvironmentView" } }, "artifacts": { "type": "array", "description": "The list of artifact contexts configured for the pipeline", "items": { "$ref": "#/components/schemas/PipelineArtifactContextView" } }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "paused": { "type": "boolean", "description": "Indicates if the pipeline is paused" }, "definition_source": { "type": "string", "description": "The source of the pipeline definition", "enum": [ "LOCAL", "REMOTE" ] }, "git_config_ref": { "type": "string", "description": "The git configuration reference type", "enum": [ "NONE", "DYNAMIC", "FIXED" ] }, "remote_path": { "type": "string", "description": "The path to the remote pipeline definition file" }, "remote_ref": { "type": "string", "description": "The ref of the remote pipeline definition" }, "remote_project_name": { "type": "string", "description": "The project name of the remote pipeline definition" }, "remote_parameters": { "type": "array", "description": "The parameters passed to the remote pipeline definition", "items": { "$ref": "#/components/schemas/PipelinePropertyView" } }, "git_config": { "$ref": "#/components/schemas/YamlDefinitionView" }, "loop": { "uniqueItems": true, "type": "array", "description": "The loop configuration for the pipeline", "items": { "type": "string" } } } }, "AddVariableInObjectRequest": { "required": [ "key", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "key": { "type": "string", "description": "The name of the variable" }, "value": { "type": "string", "description": "The value of the variable" }, "settable": { "type": "boolean", "description": "If set to `true` the variable value can be set by Buddy actions" }, "run_only_settable": { "type": "boolean", "description": "Available only if `type=VAR`. If set to `true` the variable value can be set by Buddy actions only for execution time" }, "encrypted": { "type": "boolean", "description": "If set to `true` the variable value will be encrypted and hidden" }, "description": { "type": "string", "description": "The optional description of the variable" }, "init_path": { "type": "string", "description": "Initial path for the variable" }, "defaults": { "type": "string", "description": "Default value for the variable" }, "file_path": { "type": "string", "description": "Specifies where to copy the file on each run. Set if `type` is `FILE`, `SSH_KEY`, `SSH_PUBLIC_KEY`, `IOS_KEYCHAIN`, or `IOS_PROVISION_PROFILES`" }, "file_chmod": { "type": "string", "description": "File permission set on copy to a container on each run. Set if `type` is `FILE`, `SSH_KEY`, `SSH_PUBLIC_KEY`, `IOS_KEYCHAIN`, or `IOS_PROVISION_PROFILES`" }, "file_place": { "type": "string", "description": "Set if `type` is `FILE`, `SSH_KEY`, `SSH_PUBLIC_KEY`, `IOS_KEYCHAIN`, or `IOS_PROVISION_PROFILES`. If it's `NONE`, the variable can be used as a parameter in an action. For `CONTAINER`, the given key is additionally copied to an action container on each run", "enum": [ "NONE", "CONTAINER" ] }, "password": { "type": "string", "description": "Password for certificates" }, "passphrase": { "type": "string", "description": "Passphrase for encrypted SSH keys" }, "key_identifier": { "type": "string", "description": "Key identifier for iOS certificates, provisioning profiles, or GPG keys" }, "disabled": { "type": "boolean", "description": "Set to `true` to disable the variable. Disabled variables are not injected anywhere" }, "type": { "type": "string", "description": "The type of the added variable", "enum": [ "VAR", "FILE", "SSH_KEY", "IOS_KEYCHAIN", "IOS_PROVISION_PROFILES", "SSH_PUBLIC_KEY", "GPG_KEY" ] } }, "description": "The environment variables of the sandbox" }, "CreateBuddyProjectRequest": { "required": [ "display_name" ], "type": "object", "properties": { "name": { "type": "string", "description": "The human-readable ID of the project" }, "display_name": { "type": "string", "description": "The Name of the project" }, "access": { "type": "string", "description": "Indicates if this is a public project", "enum": [ "PRIVATE", "PUBLIC" ] }, "fetch_submodules": { "type": "boolean", "description": "Defines whether the submodules are fetched during the runs in this project" }, "fetch_submodules_env_key": { "type": "string", "description": "Name of the key that will be used to authorize while fetching the submodules. Required when `fetch_submodules` is set to `true`" }, "allow_pull_requests": { "type": "boolean", "description": "Enables/disables pull requests in the project. Available only for projects synchronized with GitHub or GitHub Enterprise repository" }, "without_repository": { "type": "boolean", "description": "If set to true, the project is created without any repository attached." } } }, "CreateIntegratedProjectRequest": { "required": [ "display_name", "external_project_id", "integration" ], "type": "object", "properties": { "name": { "type": "string", "description": "The human-readable ID of the project" }, "display_name": { "type": "string", "description": "The Name of the project" }, "external_project_id": { "type": "string", "description": "Repo slug of the Bitbucket, GitHub or GitLab project. Required when adding the integrated project" }, "git_lab_project_id": { "type": "integer", "description": "ID of the project in GitLab", "format": "int32" }, "access": { "type": "string", "description": "Indicates if this is a public project", "enum": [ "PRIVATE", "PUBLIC" ] }, "integration": { "$ref": "#/components/schemas/IntegrationRequestView" }, "fetch_submodules": { "type": "boolean", "description": "Defines whether the submodules are fetched during the runs in this project" }, "fetch_submodules_env_key": { "type": "string", "description": "Name of the key that will be used to authorize while fetching the submodules. Required when `fetch_submodules` is set to `true`" }, "allow_pull_requests": { "type": "boolean", "description": "Enables/disables pull requests in the project. Available only for projects synchronized with GitHub or GitHub Enterprise repository" }, "update_default_branch_from_external": { "type": "boolean", "description": "If set to true, the default branch will be updated from GitHub/GitLab/Bitbucket." } } }, "CreateCustomRepoProjectRequest": { "required": [ "custom_repo_url", "display_name" ], "type": "object", "properties": { "name": { "type": "string", "description": "The human-readable ID of the project" }, "display_name": { "type": "string", "description": "The Name of the project" }, "custom_repo_url": { "type": "string", "description": "SSH or HTTPS url of the git repository. Required when adding the project integrated with custom git repository" }, "custom_repo_user": { "type": "string", "description": "Username used to authorize access to the git repository. Required when adding the project integrated with custom git repository" }, "custom_repo_pass": { "type": "string", "description": "Password used to authorize access to the git repository. Required when adding the project integrated with custom git repository and the provided `custom_repo_url` is the HTTPS url" }, "custom_repo_ssh_key_id": { "type": "integer", "description": "The ID of the private SSH key used to authorize access to the git repository. Required when adding the project integrated with private git server by SSH url", "format": "int32" }, "access": { "type": "string", "description": "Indicates if this is a public project", "enum": [ "PRIVATE", "PUBLIC" ] }, "fetch_submodules": { "type": "boolean", "description": "Defines whether the submodules are fetched during the runs in this project" }, "fetch_submodules_env_key": { "type": "string", "description": "Name of the key that will be used to authorize while fetching the submodules. Required when `fetch_submodules` is set to `true`" } } }, "ProjectGroupView": { "required": [ "id", "permission_set" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the group", "format": "int32" }, "name": { "type": "string", "description": "The name of the group" }, "permission_set": { "$ref": "#/components/schemas/PermissionSetView" } } }, "AddProjectGroupRequest": { "required": [ "id", "permission_set" ], "type": "object", "properties": { "id": { "type": "integer", "description": "The ID of the group", "format": "int32" }, "permission_set": { "$ref": "#/components/schemas/PermissionSetIdRequest" } } }, "PermissionSetIdRequest": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "description": "The ID of the permission set", "format": "int32" } }, "description": "User permission set configuration" }, "ProjectMemberView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the user", "format": "int32" }, "name": { "type": "string", "description": "The name of the user" }, "avatar_url": { "type": "string", "description": "The avatar URL of the user" }, "email": { "type": "string", "description": "The email address of the user" }, "admin": { "type": "boolean", "description": "Whether the user has admin privileges" }, "workspace_owner": { "type": "boolean", "description": "Whether the user is workspace owner" }, "permission_set": { "$ref": "#/components/schemas/PermissionSetView" } } }, "AddProjectMemberRequest": { "required": [ "id", "permission_set" ], "type": "object", "properties": { "id": { "type": "integer", "description": "The ID of the user", "format": "int32" }, "permission_set": { "$ref": "#/components/schemas/PermissionSetIdRequest" } } }, "TagView": { "required": [ "commit" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "name": { "type": "string", "description": "The name of the tag" }, "commit": { "$ref": "#/components/schemas/ShortCommitView" }, "message": { "type": "string", "description": "The tag message (for annotated tags)" } } }, "CreateTagRequest": { "required": [ "commit", "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "The name of the tag" }, "commit": { "$ref": "#/components/schemas/CommitReference" }, "message": { "type": "string", "description": "The tag message (for annotated tags)" } } }, "ExecutionLoopDetailsView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "status": { "type": "string", "description": "The status of the execution loop resolution", "enum": [ "OK", "ERROR" ] }, "resolved_variables": { "type": "array", "description": "The resolved execution loop variables as key-value pairs", "items": { "$ref": "#/components/schemas/SimpleVariableView" } }, "error_message": { "type": "string", "description": "The error message if the execution loop resolution failed" } }, "description": "The loop details of the execution, if the pipeline was executed in a loop" }, "ExecutionView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The unique ID of the execution", "format": "int32" }, "start_date": { "type": "string", "description": "The date and time when the execution started", "format": "date-time" }, "finish_date": { "type": "string", "description": "The date and time when the execution finished", "format": "date-time" }, "triggered_on": { "type": "string", "description": "The mode that triggered the execution", "enum": [ "CLICK", "SCHEDULE", "EVENT", "PIPELINE", "WEBHOOK", "EMAIL" ] }, "priority": { "type": "string", "description": "The priority of the execution. Default is NORMAL", "enum": [ "LOW", "NORMAL", "HIGH" ] }, "delay_until": { "type": "string", "description": "The date when the execution should be run. Should be set in the format: 2026-11-18T12:38:16.000Z", "format": "date-time" }, "refresh": { "type": "boolean", "description": "Deploy from scratch" }, "clear_cache": { "type": "boolean", "description": "Clear cache before running the pipeline" }, "status": { "type": "string", "description": "The current status of the execution", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "comment": { "type": "string", "description": "The comment or description provided for this execution" }, "branch": { "$ref": "#/components/schemas/BranchView" }, "tag": { "$ref": "#/components/schemas/TagView" }, "pull_request": { "$ref": "#/components/schemas/PullRequestView" }, "from_revision": { "$ref": "#/components/schemas/ShortCommitView" }, "to_revision": { "$ref": "#/components/schemas/ShortCommitView" }, "creator": { "$ref": "#/components/schemas/MemberView" }, "environment": { "$ref": "#/components/schemas/ShortEnvironmentView" }, "artifact_version": { "$ref": "#/components/schemas/ShortArtifactVersionView" }, "loop_details": { "$ref": "#/components/schemas/ExecutionLoopDetailsView" }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "action_executions": { "type": "array", "description": "The list of action executions within this pipeline execution", "items": { "$ref": "#/components/schemas/ShortActionExecutionView" } }, "logs_removed": { "type": "boolean", "description": "Indicates whether the logs for this execution have been removed" }, "executions": { "type": "array", "description": "The list of pipeline executions", "items": { "$ref": "#/components/schemas/ExecutionView" } }, "artifact": { "$ref": "#/components/schemas/ShortArtifactView" } } }, "LoopDetailsView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "status": { "type": "string", "description": "The status of the loop resolution", "enum": [ "RESOLVED", "DYNAMIC", "NO_LOOP", "LIMIT_REACHED", "ERROR" ] }, "resolved_variables": { "type": "array", "description": "The resolved loop variables as key-value pairs", "items": { "$ref": "#/components/schemas/SimpleVariableView" } }, "error_message": { "type": "string", "description": "The error message if the loop resolution failed" } }, "description": "The loop details of the action execution, if the action was executed in a loop" }, "PullRequestView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "name": { "type": "string", "description": "The pull request reference name (e.g., 'pull/5')" }, "number": { "type": "integer", "description": "The pull request number", "format": "int32" }, "github_html_url": { "type": "string", "description": "The HTML URL to the pull request on GitHub" } } }, "ShortActionExecutionView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "action_execution_id": { "type": "string", "description": "The unique ID of the action execution" }, "start_date": { "type": "string", "description": "The date and time when the action execution started", "format": "date-time" }, "finish_date": { "type": "string", "description": "The date and time when the action execution finished", "format": "date-time" }, "error_message": { "type": "string", "description": "The error message if the action execution failed" }, "status": { "type": "string", "description": "The current status of the action execution", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "progress": { "type": "number", "description": "The progress of the action execution in percentages (0-100)", "format": "double" }, "action": { "$ref": "#/components/schemas/ShortActionResponse" }, "terminator_id": { "type": "integer", "description": "The ID of the user who terminated the action execution", "format": "int32" }, "termination_date": { "type": "string", "description": "The date and time when the action execution was terminated", "format": "date-time" }, "approver_id": { "type": "integer", "description": "The ID of the user who approved the action execution", "format": "int32" }, "approval_date": { "type": "string", "description": "The date and time when the action execution was approved", "format": "date-time" }, "passed_variables": { "type": "array", "description": "The variables passed to this action execution", "items": { "$ref": "#/components/schemas/SimpleVariableView" } }, "outputted_variables": { "type": "array", "description": "The variables exported by this action execution", "items": { "$ref": "#/components/schemas/SimpleVariableView" } }, "visual_tests_output": { "type": "array", "description": "The output from visual tests if any were run", "items": { "$ref": "#/components/schemas/VisualTestsOutputView" } }, "sandbox_project_id": { "type": "integer", "description": "The sandbox project ID associated with this action execution", "format": "int32" }, "sandbox_id": { "type": "string", "description": "The sandbox ID associated with this action execution" }, "target": { "type": "string", "description": "The target identifier where the action was executed" }, "loop_details": { "$ref": "#/components/schemas/LoopDetailsView" } } }, "SimpleVariableView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "key": { "type": "string", "description": "The name of the variable" }, "value": { "type": "string", "description": "The value of the variable" }, "encrypted": { "type": "boolean", "description": "If set to `true` the variable value will be encrypted and hidden" } } }, "VisualTestsOutputView": { "type": "object", "properties": { "url": { "type": "string", "description": "The URL to the visual tests results" }, "status": { "type": "string", "description": "The status of the visual tests execution", "enum": [ "MATCH", "MISMATCH", "ERROR", "NEW", "SIZE_MISMATCH" ] }, "error": { "type": "string", "description": "The error message if the visual tests failed" } } }, "CancelRetryExecutionRequest": { "required": [ "operation" ], "type": "object", "properties": { "variables": { "type": "array", "description": "The list of variables to set as parameters for the pipeline", "items": { "$ref": "#/components/schemas/PassVariableRequest" } }, "operation": { "type": "string", "description": "The operation to perform on the execution", "enum": [ "CANCEL", "RETRY", "APPLY", "APPLY_VARIABLES", "SET_VARIABLES", "RUN_DELAYED", "APPROVE_VT" ] }, "approve_action_id": { "type": "string", "description": "The action execution ID (or action ID) to approve" } } }, "PassVariableRequest": { "type": "object", "properties": { "key": { "type": "string", "description": "The name of the variable" }, "value": { "type": "string", "description": "The value of the variable" }, "encrypted": { "type": "boolean", "description": "If set to `true` the variable value will be encrypted and hidden" } } }, "CommittedFileView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "content": { "$ref": "#/components/schemas/RepositoryContentView" }, "commit": { "$ref": "#/components/schemas/ShortCommitView" } } }, "RepositoryContentView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "content_type": { "type": "string", "description": "The type of the content", "enum": [ "FILE", "DIR", "SYMLINK", "SUB_MODULE", "EXTERNAL" ] }, "encoding": { "type": "string", "description": "The encoding of the content. Possible values: `base64`" }, "size": { "type": "integer", "description": "The size of the file in bytes (null for directories)", "format": "int64" }, "name": { "type": "string", "description": "The name of the file or directory" }, "path": { "type": "string", "description": "The path to the file or directory" }, "content": { "type": "string", "description": "The base64-encoded content of the file (only for files)" }, "target": { "type": "string", "description": "The target path for symbolic links" } } }, "CommitFileRequest": { "required": [ "content", "message" ], "type": "object", "properties": { "branch": { "type": "string", "description": "The name of the branch to commit to" }, "message": { "type": "string", "description": "The commit message" }, "content": { "type": "string", "description": "The base64-encoded content of the file" } } }, "CommitNewFileRequest": { "required": [ "content", "message", "path" ], "type": "object", "properties": { "branch": { "type": "string", "description": "The name of the branch to commit to" }, "message": { "type": "string", "description": "The commit message" }, "content": { "type": "string", "description": "The base64-encoded content of the file" }, "path": { "type": "string", "description": "The path where the new file should be created" } } }, "CommitRequest": { "required": [ "message" ], "type": "object", "properties": { "branch": { "type": "string", "description": "The name of the branch to commit to" }, "message": { "type": "string", "description": "The commit message" } } }, "ActionExecutionView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "action_execution_id": { "type": "string", "description": "The unique ID of the action execution" }, "start_date": { "type": "string", "description": "The date and time when the action execution started", "format": "date-time" }, "finish_date": { "type": "string", "description": "The date and time when the action execution finished", "format": "date-time" }, "error_message": { "type": "string", "description": "The error message if the action execution failed" }, "status": { "type": "string", "description": "The current status of the action execution", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "progress": { "type": "number", "description": "The progress of the action execution in percentages (0-100)", "format": "double" }, "action": { "$ref": "#/components/schemas/ShortActionResponse" }, "terminator_id": { "type": "integer", "description": "The ID of the user who terminated the action execution", "format": "int32" }, "termination_date": { "type": "string", "description": "The date and time when the action execution was terminated", "format": "date-time" }, "approver_id": { "type": "integer", "description": "The ID of the user who approved the action execution", "format": "int32" }, "approval_date": { "type": "string", "description": "The date and time when the action execution was approved", "format": "date-time" }, "passed_variables": { "type": "array", "description": "The variables passed to this action execution", "items": { "$ref": "#/components/schemas/SimpleVariableView" } }, "outputted_variables": { "type": "array", "description": "The variables exported by this action execution", "items": { "$ref": "#/components/schemas/SimpleVariableView" } }, "visual_tests_output": { "type": "array", "description": "The output from visual tests if any were run", "items": { "$ref": "#/components/schemas/VisualTestsOutputView" } }, "sandbox_project_id": { "type": "integer", "description": "The sandbox project ID associated with this action execution", "format": "int32" }, "sandbox_id": { "type": "string", "description": "The sandbox ID associated with this action execution" }, "target": { "type": "string", "description": "The target identifier where the action was executed" }, "loop_details": { "$ref": "#/components/schemas/LoopDetailsView" }, "log": { "type": "array", "description": "The console output log of the action execution", "items": { "type": "string" } }, "log_url": { "type": "string", "description": "The URL to download the full log file" } } }, "ActionExecutionLogsView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "offset": { "type": "integer", "description": "The offset (starting line number) of the returned logs", "format": "int32" }, "element_count": { "type": "integer", "description": "The number of log lines returned in this response", "format": "int32" }, "total_element_count": { "type": "integer", "description": "The total number of log lines available", "format": "int32" }, "logs": { "type": "array", "description": "The log lines of the action execution", "items": { "type": "string" } } } }, "BranchesView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "branches": { "type": "array", "items": { "$ref": "#/components/schemas/ShortBranchView" } } } }, "ShortBranchView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "name": { "type": "string", "description": "The name of the branch" }, "default": { "type": "boolean", "description": "Indicates whether this branch is default branch in the repository" } } }, "CommitIdView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "revision": { "type": "string", "description": "The full SHA hash of the commit" } } }, "CommitStatsView": { "type": "object", "properties": { "additions": { "type": "integer", "description": "The number of lines added in the commit", "format": "int32" }, "deletions": { "type": "integer", "description": "The number of lines deleted in the commit", "format": "int32" }, "total": { "type": "integer", "description": "The total number of lines changed (additions + deletions)", "format": "int32" } }, "description": "Statistics about the changes in this commit" }, "CommitView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "revision": { "type": "string", "description": "The full SHA hash of the commit" }, "author_date": { "type": "string", "description": "The date when the commit was authored", "format": "date-time" }, "commit_date": { "type": "string", "description": "The date when the commit was committed", "format": "date-time" }, "short_revision": { "type": "string", "description": "The short SHA hash of the commit (first 7 characters)" }, "message": { "type": "string", "description": "The commit message" }, "committer": { "$ref": "#/components/schemas/MemberView" }, "author": { "$ref": "#/components/schemas/MemberView" }, "stats": { "$ref": "#/components/schemas/CommitStatsView" }, "files": { "type": "array", "description": "The list of files changed in this commit", "items": { "$ref": "#/components/schemas/FileEntryView" } }, "content_url": { "type": "string", "description": "API endpoint to GET the repository contents at this commit" }, "parents": { "type": "array", "description": "The parent commits of this commit", "items": { "$ref": "#/components/schemas/CommitIdView" } } } }, "FileEntryView": { "type": "object", "properties": { "file_name": { "type": "string", "description": "The name of the file that was changed" }, "status": { "type": "string", "description": "The status of the file change", "enum": [ "ADDED", "DELETED", "MODIFIED" ] }, "additions": { "type": "integer", "description": "The number of lines added in this file", "format": "int32" }, "deletions": { "type": "integer", "description": "The number of lines deleted in this file", "format": "int32" }, "total": { "type": "integer", "description": "The total number of lines changed in this file (additions + deletions)", "format": "int32" }, "patch": { "type": "string", "description": "The git patch/diff for this file" } } }, "CommitsView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "commits": { "type": "array", "items": { "$ref": "#/components/schemas/ShortCommitView" } } } }, "CommitComparisonView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "base_commit": { "$ref": "#/components/schemas/ShortCommitView" }, "ahead": { "type": "integer", "description": "Number of commits ahead of the base", "format": "int32" }, "behind": { "type": "integer", "description": "Number of commits behind the base", "format": "int32" }, "commits": { "type": "array", "description": "List of commits in the comparison range", "items": { "$ref": "#/components/schemas/ShortCommitView" } } } }, "ExecutionsView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "page": { "type": "integer", "description": "The current page number", "format": "int32" }, "page_size": { "type": "integer", "description": "The number of elements per page", "format": "int32" }, "total_page_count": { "type": "integer", "description": "The total number of pages", "format": "int32" }, "element_count": { "type": "integer", "description": "The number of elements on the current page", "format": "int32" }, "total_element_count": { "type": "integer", "description": "The total number of elements across all pages", "format": "int32" }, "executions": { "type": "array", "items": { "$ref": "#/components/schemas/ShortExecutionView" } } } }, "ShortExecutionView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The unique ID of the execution", "format": "int32" }, "start_date": { "type": "string", "description": "The date and time when the execution started", "format": "date-time" }, "finish_date": { "type": "string", "description": "The date and time when the execution finished", "format": "date-time" }, "triggered_on": { "type": "string", "description": "The mode that triggered the execution", "enum": [ "CLICK", "SCHEDULE", "EVENT", "PIPELINE", "WEBHOOK", "EMAIL" ] }, "priority": { "type": "string", "description": "The priority of the execution. Default is NORMAL", "enum": [ "LOW", "NORMAL", "HIGH" ] }, "delay_until": { "type": "string", "description": "The date when the execution should be run. Should be set in the format: 2026-11-18T12:38:16.000Z", "format": "date-time" }, "refresh": { "type": "boolean", "description": "Deploy from scratch" }, "clear_cache": { "type": "boolean", "description": "Clear cache before running the pipeline" }, "status": { "type": "string", "description": "The current status of the execution", "enum": [ "INPROGRESS", "ENQUEUED", "TERMINATED", "SUCCESSFUL", "FAILED", "INITIAL", "NOT_EXECUTED", "SKIPPED", "TERMINATING", "WAITING_FOR_APPLY", "WAITING_FOR_VARIABLES", "WAITING_FOR_SETTABLE_VARIABLES", "WAITING_FOR_VT_SESSION" ] }, "comment": { "type": "string", "description": "The comment or description provided for this execution" }, "branch": { "$ref": "#/components/schemas/BranchView" }, "tag": { "$ref": "#/components/schemas/TagView" }, "pull_request": { "$ref": "#/components/schemas/PullRequestView" }, "from_revision": { "$ref": "#/components/schemas/ShortCommitView" }, "to_revision": { "$ref": "#/components/schemas/ShortCommitView" }, "creator": { "$ref": "#/components/schemas/MemberView" }, "environment": { "$ref": "#/components/schemas/ShortEnvironmentView" }, "artifact_version": { "$ref": "#/components/schemas/ShortArtifactVersionView" }, "loop_details": { "$ref": "#/components/schemas/ExecutionLoopDetailsView" }, "artifact": { "$ref": "#/components/schemas/ShortArtifactView" } } }, "PipelineYamlView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "yaml": { "type": "string", "description": "Base64 encoded string containing pipelines exported to YAML format" } } }, "PipelinesView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "pipelines": { "type": "array", "items": { "$ref": "#/components/schemas/ShortPipelineView" } } } }, "PipelinesYamlView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "yaml": { "type": "string", "description": "Base64 encoded string containing pipelines exported to YAML format" } } }, "ProjectGroupsView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectGroupView" } } } }, "ProjectMembersView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "members": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectMemberView" } } } }, "ProjectsView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "projects": { "type": "array", "items": { "$ref": "#/components/schemas/ShortProjectView" } } } }, "PullRequestsView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "pull_requests": { "type": "array", "items": { "$ref": "#/components/schemas/PullRequestView" } } } }, "RepositoryContentsView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "contents": { "type": "array", "items": { "$ref": "#/components/schemas/RepositoryContentView" } } } }, "ShortTagView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "name": { "type": "string", "description": "The name of the tag" } } }, "TagsView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/ShortTagView" } } } }, "BranchRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the branch to be executed", "example": "main" } }, "description": "The object containing the name field with the name of the branch to be executed when a pipeline has multiple refs or one of the refs is a wildcard" }, "PullRequestRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the pull request to be executed", "example": "123" } }, "description": "The object containing the name field with the name of the pull request to be executed when a pipeline has multiple refs or one of the refs is a wildcard" }, "RevisionRequest": { "type": "object", "properties": { "revision": { "type": "string", "description": "The full SHA hash of the commit", "example": "c4afae9e62392c0b71f75fe571cbaa745b9b0aa5" } }, "description": "The starting commit revision for this execution" }, "RunExecutionRequest": { "type": "object", "properties": { "variables": { "type": "array", "description": "The list of variables to set as parameters for the pipeline", "items": { "$ref": "#/components/schemas/PassVariableRequest" } }, "to_revision": { "$ref": "#/components/schemas/RevisionRequest" }, "from_revision": { "$ref": "#/components/schemas/RevisionRequest" }, "branch": { "$ref": "#/components/schemas/BranchRequest" }, "tag": { "$ref": "#/components/schemas/TagRequest" }, "pull_request": { "$ref": "#/components/schemas/PullRequestRequest" }, "comment": { "type": "string", "description": "The comment or description provided for this execution" }, "refresh": { "type": "boolean", "description": "Deploy from scratch" }, "clear_cache": { "type": "boolean", "description": "Clear cache before running the pipeline" }, "priority": { "type": "string", "description": "The priority of the execution. Default is NORMAL", "enum": [ "LOW", "NORMAL", "HIGH" ] }, "delay_until": { "type": "string", "description": "The date when the execution should be run. Should be set in the format: 2026-11-18T12:38:16.000Z", "format": "date-time" }, "environment": { "type": "string", "description": "The environment in which the pipeline execution runs" }, "artifact_version": { "type": "string", "description": "The artifact version to run in format 'artifact_name:version'" }, "actions_to_run": { "type": "array", "description": "Send the actions' IDs list to be run in this execution. If not sent, it will be run in accordance with the pipeline's definition", "items": { "type": "integer", "format": "int32" } } } }, "TagRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the tag to be executed", "example": "v1.0.0" } }, "description": "The object containing the name field with the name of the tag to be executed when a pipeline has multiple refs or one of the refs is a wildcard" }, "UpdatePipelineRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the pipeline" }, "identifier": { "type": "string", "description": "A human-readable ID. Alphanumeric characters, underscores, and hyphens (hyphens cannot appear at the start or end)." }, "refs": { "type": "array", "description": "Pipeline git context refs. If unset and events is empty, the pipeline counts as codeless", "items": { "type": "string" } }, "events": { "type": "array", "description": "The list of events that trigger the pipeline run", "items": { "$ref": "#/components/schemas/PipelineEventView" } }, "folder": { "type": "string", "description": "The folder name where the pipeline is organized" }, "priority": { "type": "string", "description": "The priority of the pipeline", "enum": [ "LOW", "NORMAL", "HIGH" ] }, "disabled": { "type": "boolean", "description": "Indicates if the pipeline is disabled" }, "disabled_reason": { "type": "string", "description": "The reason why the pipeline is disabled" }, "target_site_url": { "type": "string", "description": "The URL to the target site after deployment" }, "execution_message_template": { "type": "string", "description": "The template for commit status messages" }, "always_from_scratch": { "type": "boolean", "description": "Defines whether to upload everything from scratch on every run" }, "ignore_fail_on_project_status": { "type": "boolean", "description": "If set to true, the status of a given pipeline will not impact the project status on the dashboard" }, "no_skip_to_most_recent": { "type": "boolean", "description": "If set to true, the pipeline will not skip queued runs to execute the most recent one" }, "terminate_stale_runs": { "type": "boolean", "description": "If set to true, stale runs will be automatically terminated" }, "cache_scope": { "type": "string", "description": "Defines the cache scope", "enum": [ "PIPELINE", "PROJECT", "WORKSPACE" ] }, "auto_clear_cache": { "type": "boolean", "description": "Defines whether to automatically clear cache before running the pipeline" }, "pause_on_repeated_failures": { "type": "integer", "description": "Defines how many repeated failures are required to pause the pipeline", "format": "int32" }, "fetch_all_refs": { "type": "boolean", "description": "If set to true, all refs will be fetched from the repository" }, "fetch_lfs": { "type": "boolean", "description": "If set to true, LFS files will be fetched from the external repository during pipeline runs" }, "fail_on_prepare_env_warning": { "type": "boolean", "description": "If set to true, the pipeline will fail on environment preparation warnings" }, "concurrent_pipeline_runs": { "type": "boolean", "description": "Defines whether the pipeline can be run concurrently" }, "clone_depth": { "type": "integer", "description": "Defines the depth of the git clone operation for shallow clones", "format": "int32" }, "do_not_create_commit_status": { "type": "boolean", "description": "If set to true, commit statuses will not be created in the repository" }, "trigger_conditions": { "type": "array", "description": "The list of trigger conditions to meet so that the pipeline can be triggered", "items": { "$ref": "#/components/schemas/TriggerConditionView" } }, "variables": { "type": "array", "description": "The list of environment variables defined for the pipeline", "items": { "$ref": "#/components/schemas/AddVariableInObjectRequest" } }, "resources": { "type": "string", "description": "The resource configuration for the pipeline run", "enum": [ "DEFAULT", "NANO", "SMALL", "MEDIUM", "LARGE", "XLARGE", "CUSTOM", "X2LARGE" ] }, "git_changeset_base": { "type": "string", "description": "The base for git changeset calculation. Determines which changes trigger the pipeline", "enum": [ "LATEST_RUN", "LATEST_RUN_MATCHING_REF", "PULL_REQUEST" ] }, "filesystem_changeset_base": { "type": "string", "description": "The base for filesystem changeset calculation. Determines which file changes trigger the pipeline", "enum": [ "DATE_MODIFIED", "CONTENTS" ] }, "tags": { "uniqueItems": true, "type": "array", "description": "The list of tags associated with the pipeline for organization", "items": { "type": "string" } }, "cpu": { "type": "string", "description": "The CPU architecture for the pipeline run", "enum": [ "X64", "ARM", "X86" ] }, "description_required": { "type": "boolean", "description": "If set to true, a description is required when executing the pipeline manually" }, "manage_variables_by_yaml": { "type": "boolean", "description": "If set to true, variables are managed by YAML configuration" }, "manage_permissions_by_yaml": { "type": "boolean", "description": "If set to true, permissions are managed by YAML configuration" }, "environments": { "type": "array", "description": "The list of environments attached to the pipeline", "items": { "$ref": "#/components/schemas/EnvironmentView" } }, "artifacts": { "type": "array", "description": "The list of artifact contexts configured for the pipeline", "items": { "$ref": "#/components/schemas/PipelineArtifactContextView" } }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "paused": { "type": "boolean", "description": "Indicates if the pipeline is paused" }, "definition_source": { "type": "string", "description": "The source of the pipeline definition", "enum": [ "LOCAL", "REMOTE" ] }, "git_config_ref": { "type": "string", "description": "The git configuration reference type", "enum": [ "NONE", "DYNAMIC", "FIXED" ] }, "remote_path": { "type": "string", "description": "The path to the remote pipeline definition file" }, "remote_ref": { "type": "string", "description": "The ref of the remote pipeline definition" }, "remote_project_name": { "type": "string", "description": "The project name of the remote pipeline definition" }, "remote_parameters": { "type": "array", "description": "The parameters passed to the remote pipeline definition", "items": { "$ref": "#/components/schemas/PipelinePropertyView" } }, "git_config": { "$ref": "#/components/schemas/YamlDefinitionView" }, "loop": { "uniqueItems": true, "type": "array", "description": "The loop configuration for the pipeline", "items": { "type": "string" } } } }, "ClearCacheRequest": { "required": [ "clear_cache" ], "type": "object", "properties": { "clear_cache": { "type": "boolean", "description": "Set to true to clear all action caches for this pipeline" } } }, "UpdateProjectRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "The human-readable ID of the project" }, "display_name": { "type": "string", "description": "The Name of the project" }, "status": { "type": "string", "description": "The status of the project", "enum": [ "ACTIVE", "CLOSED" ] }, "access": { "type": "string", "description": "Indicates if this is a public project", "enum": [ "PRIVATE", "PUBLIC" ] }, "fetch_submodules": { "type": "boolean", "description": "Defines whether the submodules are fetched during the runs in this project" }, "fetch_submodules_env_key": { "type": "string", "description": "Name of the key that will be used to authorize while fetching the submodules. Required when `fetch_submodules` is set to `true`" }, "allow_pull_requests": { "type": "boolean", "description": "Enables/disables pull requests in the project. Available only for projects synchronized with GitHub or GitHub Enterprise repository" }, "update_default_branch_from_external": { "type": "boolean", "description": "If set to true, the default branch will be updated from GitHub/GitLab/Bitbucket." } } }, "UpdateProjectGroupRequest": { "required": [ "permission_set" ], "type": "object", "properties": { "permission_set": { "$ref": "#/components/schemas/PermissionSetIdRequest" } } }, "UpdateProjectMemberRequest": { "required": [ "permission_set" ], "type": "object", "properties": { "permission_set": { "$ref": "#/components/schemas/PermissionSetIdRequest" } } }, "DistributionView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the distribution", "format": "int32" }, "identifier": { "type": "string", "description": "A human-readable ID of the distribution. Alphanumeric characters, underscores, and hyphens (hyphens cannot appear at the start or end)." }, "name": { "type": "string", "description": "The name of the distribution" }, "disabled": { "type": "boolean", "description": "Indicates if the distribution is disabled" }, "scope": { "type": "string", "description": "The scope of the distribution", "enum": [ "WORKSPACE", "PROJECT", "ENVIRONMENT" ] }, "project": { "$ref": "#/components/schemas/ShortProjectView" }, "environment": { "$ref": "#/components/schemas/ShortEnvironmentView" }, "routes": { "type": "array", "description": "The list of routes associated with the distribution", "items": { "$ref": "#/components/schemas/RouteView" } }, "permissions": { "$ref": "#/components/schemas/PermissionsView" } } }, "RouteView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the route", "format": "int32" }, "type": { "type": "string", "description": "The type of the route", "enum": [ "PROXY", "REDIRECT", "CLOAKING", "PROXY_NO_CACHE" ] }, "subdomain": { "type": "string", "description": "The subdomain of the route" }, "domain": { "type": "string", "description": "The domain of the route" }, "path": { "type": "string", "description": "The path of the route" }, "zone_type": { "type": "string", "description": "The type of DNS zone for custom domain routing", "enum": [ "ROUTING", "CLAIMABLE", "USER", "CLAIMED", "NS_POINTED", "CNAME_POINTED" ] }, "targets": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TargetView" }, "description": "The targets of the route" } } }, "CreateDistributionRequest": { "required": [ "name", "scope" ], "type": "object", "properties": { "name": { "type": "string", "description": "The name of the distribution" }, "scope": { "type": "string", "description": "The scope of the distribution", "enum": [ "WORKSPACE", "PROJECT", "ENVIRONMENT" ] }, "identifier": { "type": "string", "description": "A human-readable ID of the distribution. Alphanumeric characters, underscores, and hyphens (hyphens cannot appear at the start or end)." }, "project_name": { "type": "string", "description": "The name of the project for the distribution" }, "environment_id": { "type": "string", "description": "The ID of the environment for the distribution" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" } } }, "DistributionsView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "distributions": { "type": "array", "items": { "$ref": "#/components/schemas/ShortDistributionView" } } } }, "ShortDistributionView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the distribution", "format": "int32" }, "identifier": { "type": "string", "description": "A human-readable ID of the distribution. Alphanumeric characters, underscores, and hyphens (hyphens cannot appear at the start or end)." }, "name": { "type": "string", "description": "The name of the distribution" }, "disabled": { "type": "boolean", "description": "Indicates if the distribution is disabled" } }, "description": "List of distributions in the workspace" }, "RoutableDomainView": { "type": "object", "properties": { "domain": { "type": "string", "description": "The domain available for routing" }, "type": { "type": "string", "description": "The type of DNS zone", "enum": [ "ROUTING", "CLAIMABLE", "USER", "CLAIMED", "NS_POINTED", "CNAME_POINTED" ] }, "zone_id": { "type": "string", "description": "The ID of the DNS zone" } } }, "RoutableDomainsView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "routable_domains": { "type": "array", "items": { "$ref": "#/components/schemas/RoutableDomainView" } } } }, "UpdateDistributionRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the distribution" }, "identifier": { "type": "string", "description": "A human-readable ID of the distribution. Alphanumeric characters, underscores, and hyphens (hyphens cannot appear at the start or end)." }, "scope": { "type": "string", "description": "The scope of the distribution", "enum": [ "WORKSPACE", "PROJECT", "ENVIRONMENT" ] }, "project_name": { "type": "string", "description": "The name of the project for the distribution" }, "disabled": { "type": "boolean", "description": "Indicates if the distribution is disabled" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" } } }, "ArtifactTargetRequest": { "required": [ "id", "version_id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the artifact" }, "version_id": { "type": "string", "description": "The ID of the artifact version" } }, "description": "The artifact configuration (for ARTIFACT type)" }, "CreateRouteRequest": { "required": [ "targets", "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "The type of the route", "enum": [ "PROXY", "REDIRECT", "CLOAKING", "PROXY_NO_CACHE" ] }, "subdomain": { "type": "string", "description": "Subdomain for the route. For a claimable domain, the rightmost label is extracted as the claim." }, "domain": { "type": "string", "description": "Optional. Domain on which the route is created." }, "path": { "type": "string", "description": "The path of the route" }, "targets": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TargetRequest" }, "description": "The targets of the route" } } }, "SandboxTargetRequest": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the sandbox" }, "endpoint": { "type": "string", "description": "The endpoint of the sandbox" } }, "description": "Sandbox target configuration" }, "TargetRequest": { "required": [ "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "The type of the target", "enum": [ "EXTERNAL", "ARTIFACT", "SANDBOX", "TUNNEL" ] }, "external_url": { "type": "string", "description": "The external URL (for EXTERNAL type)" }, "artifact": { "$ref": "#/components/schemas/ArtifactTargetRequest" }, "sandbox": { "$ref": "#/components/schemas/SandboxTargetRequest" }, "tunnel": { "$ref": "#/components/schemas/TunnelTargetRequest" } }, "description": "Route target configuration" }, "TunnelTargetRequest": { "required": [ "id", "tunnel_id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the tunnel agent" }, "tunnel_id": { "type": "string", "description": "The ID of the tunnel" } }, "description": "Tunnel target configuration" }, "RoutesView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "routes": { "type": "array", "items": { "$ref": "#/components/schemas/RouteView" } } } }, "UpdateRouteRequest": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of the route", "enum": [ "PROXY", "REDIRECT", "CLOAKING", "PROXY_NO_CACHE" ] }, "subdomain": { "type": "string", "description": "Subdomain for the route. For a claimable domain, the rightmost label is extracted as the claim." }, "domain": { "type": "string", "description": "Optional. Domain on which the route is created." }, "path": { "type": "string", "description": "The path of the route" }, "targets": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TargetRequest" }, "description": "The targets of the route" } } }, "SandboxResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "string", "description": "The ID of the sandbox" }, "identifier": { "type": "string", "description": "A human-readable ID. Alphanumeric characters, underscores, and hyphens (hyphens cannot appear at the start or end)." }, "name": { "type": "string", "description": "The name of the sandbox" }, "status": { "type": "string", "description": "The current status of the sandbox", "enum": [ "STARTING", "STOPPING", "FAILED", "RUNNING", "STOPPED", "RESTORING" ] }, "setup_status": { "type": "string", "description": "The current setup status of the sandbox", "enum": [ "INPROGRESS", "SUCCESS", "FAILED", "STALE" ] }, "os": { "type": "string", "description": "The operating system of the sandbox [\"ubuntu:22.04\", \"ubuntu:24.04\"]" }, "resources": { "type": "string", "description": "The resource configuration of the sandbox (CPU x RAM)", "enum": [ "1x2", "2x4", "3x6", "4x8", "5x10", "6x12", "7x14", "8x16", "9x18", "10x20", "11x22", "12x24", "CUSTOM" ] }, "first_boot_commands": { "type": "string", "description": "The commands to run during first boot of the sandbox" }, "app_dir": { "type": "string", "description": "The application directory of the sandbox" }, "apps": { "type": "array", "description": "The list of apps (run commands) for the sandbox", "items": { "$ref": "#/components/schemas/SandboxAppView" } }, "fetch": { "type": "array", "description": "The list of items (repositories and artifacts) to fetch into the sandbox", "items": { "$ref": "#/components/schemas/SandboxFetchView" } }, "timeout": { "type": "integer", "description": "The timeout in seconds after which the sandbox will be automatically stopped", "format": "int32" }, "tags": { "type": "array", "description": "The list of tags associated with the sandbox", "items": { "type": "string" } }, "boot_logs": { "type": "array", "description": "The boot logs of the sandbox", "items": { "type": "string" } }, "endpoints": { "type": "array", "description": "The tunnel endpoints of the sandbox", "items": { "$ref": "#/components/schemas/TunnelView" } }, "ssh_host": { "type": "string", "description": "The SSH hostname" }, "ssh_port": { "type": "integer", "description": "The SSH port", "format": "int32" }, "project": { "$ref": "#/components/schemas/ProjectView" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" }, "variables": { "type": "array", "description": "The environment variables of the sandbox", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } } } }, "CloneSandboxRequest": { "required": [ "name", "source_sandbox_id" ], "type": "object", "properties": { "source_sandbox_id": { "type": "string", "description": "The ID of the sandbox to clone" }, "name": { "type": "string", "description": "The name of the sandbox" }, "identifier": { "type": "string", "description": "A human-readable ID. Alphanumeric characters, underscores, and hyphens (hyphens cannot appear at the start or end)." } } }, "CreateFromSnapshotRequest": { "required": [ "name", "snapshot_id" ], "type": "object", "properties": { "snapshot_id": { "type": "string", "description": "The ID of the snapshot to create from" }, "name": { "type": "string", "description": "The name of the sandbox" }, "identifier": { "type": "string", "description": "A human-readable ID. Alphanumeric characters, underscores, and hyphens (hyphens cannot appear at the start or end)." }, "os": { "type": "string", "description": "The operating system of the sandbox [\"ubuntu:22.04\", \"ubuntu:24.04\"]" }, "resources": { "type": "string", "description": "The resource configuration of the sandbox (CPU x RAM)", "enum": [ "1x2", "2x4", "3x6", "4x8", "5x10", "6x12", "7x14", "8x16", "9x18", "10x20", "11x22", "12x24", "CUSTOM" ] }, "first_boot_commands": { "type": "string", "description": "The commands to run during first boot of the sandbox" }, "app_dir": { "type": "string", "description": "The application directory of the sandbox" }, "apps": { "type": "array", "description": "The list of apps (run commands) for the sandbox", "items": { "type": "string", "description": "The list of apps (run commands) for the sandbox" } }, "tags": { "type": "array", "description": "The list of tags associated with the sandbox", "items": { "type": "string", "description": "The list of tags associated with the sandbox" } }, "endpoints": { "type": "array", "description": "The tunnel endpoints of the sandbox", "items": { "$ref": "#/components/schemas/TunnelView" } }, "variables": { "type": "array", "description": "The environment variables of the sandbox", "items": { "$ref": "#/components/schemas/EnvironmentVariableView" } } } }, "CreateNewSandboxRequest": { "required": [ "name", "os" ], "type": "object", "properties": { "name": { "type": "string", "description": "The name of the sandbox" }, "identifier": { "type": "string", "description": "A human-readable ID. Alphanumeric characters, underscores, and hyphens (hyphens cannot appear at the start or end)." }, "os": { "type": "string", "description": "The operating system of the sandbox [\"ubuntu:22.04\", \"ubuntu:24.04\"]" }, "resources": { "type": "string", "description": "The resource configuration of the sandbox (CPU x RAM)", "enum": [ "1x2", "2x4", "3x6", "4x8", "5x10", "6x12", "7x14", "8x16", "9x18", "10x20", "11x22", "12x24", "CUSTOM" ] }, "first_boot_commands": { "type": "string", "description": "The commands to run during first boot of the sandbox" }, "app_dir": { "type": "string", "description": "The application directory of the sandbox" }, "apps": { "type": "array", "description": "The list of apps (run commands) for the sandbox", "items": { "type": "string", "description": "The list of apps (run commands) for the sandbox" } }, "fetch": { "type": "array", "description": "The list of items (repositories and artifacts) to fetch into the sandbox", "items": { "$ref": "#/components/schemas/SandboxFetchView" } }, "tags": { "type": "array", "description": "The list of tags associated with the sandbox", "items": { "type": "string", "description": "The list of tags associated with the sandbox" } }, "endpoints": { "type": "array", "description": "The tunnel endpoints of the sandbox", "items": { "$ref": "#/components/schemas/TunnelView" } }, "variables": { "type": "array", "description": "The environment variables of the sandbox", "items": { "$ref": "#/components/schemas/AddVariableInObjectRequest" } }, "timeout": { "type": "integer", "description": "The timeout in seconds after which the sandbox will be automatically stopped", "format": "int32" }, "permissions": { "$ref": "#/components/schemas/PermissionsView" } } }, "SandboxYamlView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "yaml": { "type": "string", "description": "The base64-encoded YAML configuration of the sandbox" } } }, "SnapshotView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "string", "description": "The ID of the snapshot" }, "name": { "type": "string", "description": "Snapshot name" }, "size": { "type": "integer", "description": "Snapshot size in GB", "format": "int32" }, "status": { "type": "string", "description": "Snapshot status", "enum": [ "CREATING", "CREATED", "DELETING", "FAILED" ] }, "create_date": { "type": "string", "description": "Snapshot creation date", "format": "date-time" }, "created_by": { "$ref": "#/components/schemas/MemberView" } } }, "AddSnapshotRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "Snapshot name" } } }, "SandboxContentItem": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "type": { "type": "string", "description": "The content type (FILE or DIR)", "example": "FILE", "enum": [ "FILE", "DIR" ] }, "name": { "type": "string", "description": "The name of the file or directory", "example": "index.js" }, "path": { "type": "string", "description": "The path to the file or directory", "example": "app/src/index.js" }, "size": { "type": "integer", "description": "The size of the file in bytes", "format": "int64", "example": 1024 } }, "description": "Content item in a sandbox" }, "SandboxCommandView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "string", "description": "The ID of the command" }, "command": { "type": "string", "description": "Command to execute in the sandbox" }, "runtime": { "type": "string", "description": "Runtime environment for command execution (default: `BASH`)", "enum": [ "BASH", "JAVASCRIPT", "TYPESCRIPT", "PYTHON" ] }, "status": { "type": "string", "description": "Command execution status", "enum": [ "INPROGRESS", "SUCCESSFUL", "FAILED" ] }, "exit_code": { "type": "integer", "description": "Command exit code", "format": "int32" }, "start_date": { "type": "string", "description": "Command execution start date", "format": "date-time" }, "finish_date": { "type": "string", "description": "Command execution finish date", "format": "date-time" }, "logs_url": { "type": "string", "description": "API endpoint URL to retrieve logs for this command" } } }, "ExecuteSandboxCommandRequest": { "required": [ "command" ], "type": "object", "properties": { "command": { "type": "string", "description": "Command to execute in the sandbox", "example": "ls -la" }, "runtime": { "type": "string", "description": "Runtime environment for command execution (default: `BASH`)", "enum": [ "BASH", "JAVASCRIPT", "TYPESCRIPT", "PYTHON" ] } } }, "ShortSnapshotView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "string", "description": "The ID of the snapshot" }, "name": { "type": "string", "description": "Snapshot name" }, "size": { "type": "integer", "description": "Snapshot size in GB", "format": "int32" }, "status": { "type": "string", "description": "Snapshot status", "enum": [ "CREATING", "CREATED", "DELETING", "FAILED" ] }, "create_date": { "type": "string", "description": "Snapshot creation date", "format": "date-time" } } }, "SnapshotsView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "snapshots": { "type": "array", "description": "Collection of snapshots", "items": { "$ref": "#/components/schemas/ShortSnapshotView" } } } }, "SandboxAppLogsView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "cursor": { "type": "string", "description": "Cursor for pagination" }, "logs": { "type": "array", "description": "Application log entries", "items": { "type": "string" } } } }, "SandboxCommandLog": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of command output stream", "enum": [ "STDOUT", "STDERR" ] }, "data": { "type": "string", "description": "The command execution logs." } } }, "SandboxCommandsView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "commands": { "type": "array", "items": { "$ref": "#/components/schemas/SandboxCommandView" } } } }, "SandboxContentView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "contents": { "type": "array", "description": "List of content items in the directory", "items": { "$ref": "#/components/schemas/SandboxContentItem" } } }, "description": "Sandbox content listing" }, "SandboxIdView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "string", "description": "The ID of the sandbox" }, "identifier": { "type": "string", "description": "A human-readable ID. Alphanumeric characters, underscores, and hyphens (hyphens cannot appear at the start or end)." }, "name": { "type": "string", "description": "The name of the sandbox" }, "status": { "type": "string", "description": "The current status of the sandbox", "enum": [ "STARTING", "STOPPING", "FAILED", "RUNNING", "STOPPED", "RESTORING" ] }, "setup_status": { "type": "string", "description": "The current setup status of the sandbox", "enum": [ "INPROGRESS", "SUCCESS", "FAILED" ] } }, "description": "Sandbox reference" }, "SandboxesView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "sandboxes": { "type": "array", "items": { "$ref": "#/components/schemas/SandboxIdView" } } } }, "UpdateSandboxRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the sandbox" }, "identifier": { "type": "string", "description": "A human-readable ID. Alphanumeric characters, underscores, and hyphens (hyphens cannot appear at the start or end)." }, "resources": { "type": "string", "description": "The resource configuration of the sandbox (CPU x RAM)", "enum": [ "1x2", "2x4", "3x6", "4x8", "5x10", "6x12", "7x14", "8x16", "9x18", "10x20", "11x22", "12x24", "CUSTOM" ] }, "first_boot_commands": { "type": "string", "description": "The commands to run during first boot of the sandbox" }, "app_dir": { "type": "string", "description": "The application directory of the sandbox" }, "apps": { "type": "array", "description": "The list of apps (run commands) for the sandbox", "items": { "$ref": "#/components/schemas/SandboxAppView" } }, "fetch": { "type": "array", "description": "The list of items (repositories and artifacts) to fetch into the sandbox", "items": { "$ref": "#/components/schemas/SandboxFetchView" } }, "timeout": { "type": "integer", "description": "The timeout in seconds after which the sandbox will be automatically stopped", "format": "int32" }, "tags": { "type": "array", "description": "The list of tags associated with the sandbox", "items": { "type": "string", "description": "The list of tags associated with the sandbox" } }, "endpoints": { "type": "array", "description": "The tunnel endpoints of the sandbox", "items": { "$ref": "#/components/schemas/TunnelView" } }, "variables": { "type": "array", "description": "The environment variables of the sandbox", "items": { "$ref": "#/components/schemas/AddVariableInObjectRequest" } }, "permissions": { "$ref": "#/components/schemas/PermissionsView" } } }, "TargetsView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "targets": { "type": "array", "items": { "$ref": "#/components/schemas/TargetView" } } } }, "TunnelTokenView": { "type": "object", "properties": { "token": { "type": "string", "description": "The JWT token for tunnel authentication" } } }, "UserEmailView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "email": { "type": "string", "description": "The email address" }, "confirmed": { "type": "boolean", "description": "Whether the email address is confirmed" } } }, "AddEmailRequest": { "required": [ "email" ], "type": "object", "properties": { "email": { "type": "string", "description": "The email address" } } }, "PublicSSHKeyView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the SSH key", "format": "int32" }, "title": { "type": "string", "description": "The title/name of the SSH key" }, "content": { "type": "string", "description": "The SSH public key content" } } }, "AddSSHKeyRequest": { "required": [ "content" ], "type": "object", "properties": { "title": { "type": "string", "description": "The title/name of the SSH key" }, "content": { "type": "string", "description": "The SSH public key content" } } }, "AccessTokenView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "string", "description": "The ID of the access token" }, "name": { "type": "string", "description": "The name/description of the access token" }, "token": { "type": "string", "description": "The actual access token value. Only returned when creating a new token" }, "expires_in": { "type": "integer", "description": "The token expiration time in days", "format": "int32" }, "expires_at": { "type": "string", "description": "The token expiration date", "format": "date-time" }, "scopes": { "uniqueItems": true, "type": "array", "description": "The array of OAuth scopes granted to the token", "items": { "type": "string", "enum": [ "WORKSPACE", "WORKSPACES_MANAGE", "PROJECT_DELETE", "REPOSITORY_READ", "REPOSITORY_WRITE", "EXECUTION_INFO", "EXECUTION_RUN", "EXECUTION_MANAGE", "USER_INFO", "USER_KEY", "MANAGE_EMAILS", "USER_EMAIL", "MEMBER_EMAIL", "WEBHOOK_INFO", "WEBHOOK_ADD", "WEBHOOK_MANAGE", "ENVIRONMENT_INFO", "ENVIRONMENT_ADD", "ENVIRONMENT_MANAGE", "VARIABLE_INFO", "VARIABLE_ADD", "VARIABLE_MANAGE", "TARGET_INFO", "TARGET_ADD", "TARGET_MANAGE", "INTEGRATION_INFO", "INTEGRATION_ADD", "INTEGRATION_MANAGE", "TOKEN_INFO", "TOKEN_MANAGE", "ARTIFACT_READ", "ARTIFACT_WRITE", "ARTIFACT_MANAGE", "ZONE_READ", "ZONE_WRITE", "ZONE_MANAGE", "UNIT_TEST_INFO", "UNIT_TEST_MANAGE", "SANDBOX_INFO", "SANDBOX_MANAGE", "TUNNEL_INFO", "TUNNEL_MANAGE", "VISUAL_TEST_INFO", "VISUAL_TEST_MANAGE", "CRAWL_INFO", "CRAWL_MANAGE", "DISTRIBUTION_INFO", "DISTRIBUTION_ADD", "DISTRIBUTION_MANAGE" ] } }, "ip_restrictions": { "type": "array", "description": "The array of IP addresses that are allowed to use this token", "items": { "type": "string" } }, "workspace_restrictions": { "type": "array", "description": "The array of workspaces for which this token can be used", "items": { "type": "string" } } } }, "AddAccessTokenRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "The name/description of the access token" }, "expires_in": { "type": "integer", "description": "The token expiration time in days", "format": "int32" }, "expires_at": { "type": "string", "description": "The token expiration date", "format": "date-time" }, "scopes": { "uniqueItems": true, "type": "array", "description": "The array of OAuth scopes granted to the token", "items": { "type": "string", "enum": [ "WORKSPACE", "WORKSPACES_MANAGE", "PROJECT_DELETE", "REPOSITORY_READ", "REPOSITORY_WRITE", "EXECUTION_INFO", "EXECUTION_RUN", "EXECUTION_MANAGE", "USER_INFO", "USER_KEY", "MANAGE_EMAILS", "USER_EMAIL", "MEMBER_EMAIL", "WEBHOOK_INFO", "WEBHOOK_ADD", "WEBHOOK_MANAGE", "ENVIRONMENT_INFO", "ENVIRONMENT_ADD", "ENVIRONMENT_MANAGE", "VARIABLE_INFO", "VARIABLE_ADD", "VARIABLE_MANAGE", "TARGET_INFO", "TARGET_ADD", "TARGET_MANAGE", "INTEGRATION_INFO", "INTEGRATION_ADD", "INTEGRATION_MANAGE", "TOKEN_INFO", "TOKEN_MANAGE", "ARTIFACT_READ", "ARTIFACT_WRITE", "ARTIFACT_MANAGE", "ZONE_READ", "ZONE_WRITE", "ZONE_MANAGE", "UNIT_TEST_INFO", "UNIT_TEST_MANAGE", "SANDBOX_INFO", "SANDBOX_MANAGE", "TUNNEL_INFO", "TUNNEL_MANAGE", "VISUAL_TEST_INFO", "VISUAL_TEST_MANAGE", "CRAWL_INFO", "CRAWL_MANAGE", "DISTRIBUTION_INFO", "DISTRIBUTION_ADD", "DISTRIBUTION_MANAGE" ] } }, "ip_restrictions": { "type": "array", "description": "The array of IP addresses that are allowed to use this token", "items": { "type": "string" } }, "workspace_restrictions": { "type": "array", "description": "The array of workspaces for which this token can be used", "items": { "type": "string" } } } }, "UserEmailsView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "emails": { "type": "array", "items": { "$ref": "#/components/schemas/UserEmailView" } } } }, "PublicSSHKeysView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "keys": { "type": "array", "items": { "$ref": "#/components/schemas/PublicSSHKeyView" } } } }, "AccessTokensView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "access_tokens": { "type": "array", "items": { "$ref": "#/components/schemas/ShortAccessTokenView" } } } }, "ShortAccessTokenView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "string", "description": "The ID of the access token" }, "name": { "type": "string", "description": "The name/description of the access token" }, "token": { "type": "string", "description": "The actual access token value. Only returned when creating a new token" }, "expires_in": { "type": "integer", "description": "The token expiration time in days", "format": "int32" }, "expires_at": { "type": "string", "description": "The token expiration date", "format": "date-time" } } }, "UserView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the user", "format": "int32" }, "name": { "type": "string", "description": "The name of the user" }, "avatar_url": { "type": "string", "description": "The avatar URL of the user" }, "email": { "type": "string", "description": "The email address of the user" }, "workspaces_url": { "type": "string", "description": "The workspaces URL of the user" } } }, "UpdateUserRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the user" } } }, "ActionIdView": { "required": [ "id" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the action", "format": "int32" } }, "description": "Action reference" }, "EnvironmentIdView": { "required": [ "id" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "string", "description": "The ID of the environment" }, "identifier": { "type": "string", "description": "A human-readable ID of the environment. Alphanumeric characters, underscores, and hyphens (hyphens cannot appear at the start or end)." }, "name": { "type": "string", "description": "The name of the environment" } }, "description": "Environment reference" }, "VariableView": { "required": [ "key" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the variable", "format": "int32" }, "key": { "type": "string", "description": "The name of the variable" }, "type": { "type": "string", "description": "The type of the added variable", "enum": [ "VAR", "FILE", "SSH_KEY", "IOS_KEYCHAIN", "IOS_PROVISION_PROFILES", "SSH_PUBLIC_KEY", "GPG_KEY" ] }, "value": { "type": "string", "description": "The value of the variable" }, "encrypted": { "type": "boolean", "description": "If set to `true` the variable value will be encrypted and hidden" }, "description": { "type": "string", "description": "The optional description of the variable" }, "settable": { "type": "boolean", "description": "If set to `true` the variable value can be set by Buddy actions" }, "project": { "$ref": "#/components/schemas/ProjectView" }, "pipeline": { "$ref": "#/components/schemas/ShortPipelineView" }, "action": { "$ref": "#/components/schemas/ActionIdView" }, "sandbox": { "$ref": "#/components/schemas/SandboxIdView" }, "environment": { "$ref": "#/components/schemas/EnvironmentIdView" }, "run_only_settable": { "type": "boolean", "description": "Available only if `type=VAR`. If set to `true` the variable value can be set by Buddy actions only for execution time" }, "init_path": { "type": "string", "description": "Initial path for the variable" }, "defaults": { "type": "string", "description": "Default value for the variable" }, "file_path": { "type": "string", "description": "Specifies where to copy the file on each run. Set if `type` is `FILE`, `SSH_KEY`, `SSH_PUBLIC_KEY`, `IOS_KEYCHAIN`, or `IOS_PROVISION_PROFILES`" }, "file_chmod": { "type": "string", "description": "File permission set on copy to a container on each run. Set if `type` is `FILE`, `SSH_KEY`, `SSH_PUBLIC_KEY`, `IOS_KEYCHAIN`, or `IOS_PROVISION_PROFILES`" }, "file_place": { "type": "string", "description": "Set if `type` is `FILE`, `SSH_KEY`, `SSH_PUBLIC_KEY`, `IOS_KEYCHAIN`, or `IOS_PROVISION_PROFILES`. If it's `NONE`, the variable can be used as a parameter in an action. For `CONTAINER`, the given key is additionally copied to an action container on each run", "enum": [ "NONE", "CONTAINER" ] }, "binary": { "type": "boolean", "description": "Whether the file is binary" }, "public_value": { "type": "string", "description": "Public value for SSH key type variables" }, "key_fingerprint": { "type": "string", "description": "Fingerprint of SSH key" }, "checksum": { "type": "string", "description": "Checksum of the variable value" }, "password": { "type": "string", "description": "Password for certificates" }, "passphrase": { "type": "string", "description": "Passphrase for encrypted SSH keys" }, "key_identifier": { "type": "string", "description": "Key identifier for iOS certificates, provisioning profiles, or GPG keys" }, "disabled": { "type": "boolean", "description": "Set to `true` to disable the variable. Disabled variables are not injected anywhere" } } }, "AddVariableRequest": { "required": [ "key", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "key": { "type": "string", "description": "The name of the variable" }, "value": { "type": "string", "description": "The value of the variable" }, "settable": { "type": "boolean", "description": "If set to `true` the variable value can be set by Buddy actions" }, "run_only_settable": { "type": "boolean", "description": "Available only if `type=VAR`. If set to `true` the variable value can be set by Buddy actions only for execution time" }, "encrypted": { "type": "boolean", "description": "If set to `true` the variable value will be encrypted and hidden" }, "description": { "type": "string", "description": "The optional description of the variable" }, "init_path": { "type": "string", "description": "Initial path for the variable" }, "defaults": { "type": "string", "description": "Default value for the variable" }, "file_path": { "type": "string", "description": "Specifies where to copy the file on each run. Set if `type` is `FILE`, `SSH_KEY`, `SSH_PUBLIC_KEY`, `IOS_KEYCHAIN`, or `IOS_PROVISION_PROFILES`" }, "file_chmod": { "type": "string", "description": "File permission set on copy to a container on each run. Set if `type` is `FILE`, `SSH_KEY`, `SSH_PUBLIC_KEY`, `IOS_KEYCHAIN`, or `IOS_PROVISION_PROFILES`" }, "file_place": { "type": "string", "description": "Set if `type` is `FILE`, `SSH_KEY`, `SSH_PUBLIC_KEY`, `IOS_KEYCHAIN`, or `IOS_PROVISION_PROFILES`. If it's `NONE`, the variable can be used as a parameter in an action. For `CONTAINER`, the given key is additionally copied to an action container on each run", "enum": [ "NONE", "CONTAINER" ] }, "password": { "type": "string", "description": "Password for certificates" }, "passphrase": { "type": "string", "description": "Passphrase for encrypted SSH keys" }, "key_identifier": { "type": "string", "description": "Key identifier for iOS certificates, provisioning profiles, or GPG keys" }, "disabled": { "type": "boolean", "description": "Set to `true` to disable the variable. Disabled variables are not injected anywhere" }, "type": { "type": "string", "description": "The type of the added variable", "enum": [ "VAR", "FILE", "SSH_KEY", "IOS_KEYCHAIN", "IOS_PROVISION_PROFILES", "SSH_PUBLIC_KEY", "GPG_KEY" ] }, "project": { "$ref": "#/components/schemas/ProjectNameView" }, "pipeline": { "$ref": "#/components/schemas/PipelineIdView" }, "action": { "$ref": "#/components/schemas/ActionIdView" }, "sandbox": { "$ref": "#/components/schemas/SandboxIdView" }, "environment": { "$ref": "#/components/schemas/EnvironmentIdView" } } }, "PipelineIdView": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "description": "The unique ID of the pipeline", "format": "int32" } }, "description": "Pipeline reference" }, "VariablesView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "variables": { "type": "array", "items": { "$ref": "#/components/schemas/VariableView" } } } }, "UpdateVariableRequest": { "required": [ "key" ], "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "key": { "type": "string", "description": "The name of the variable" }, "value": { "type": "string", "description": "The value of the variable" }, "settable": { "type": "boolean", "description": "If set to `true` the variable value can be set by Buddy actions" }, "run_only_settable": { "type": "boolean", "description": "Available only if `type=VAR`. If set to `true` the variable value can be set by Buddy actions only for execution time" }, "encrypted": { "type": "boolean", "description": "If set to `true` the variable value will be encrypted and hidden" }, "description": { "type": "string", "description": "The optional description of the variable" }, "init_path": { "type": "string", "description": "Initial path for the variable" }, "defaults": { "type": "string", "description": "Default value for the variable" }, "file_path": { "type": "string", "description": "Specifies where to copy the file on each run. Set if `type` is `FILE`, `SSH_KEY`, `SSH_PUBLIC_KEY`, `IOS_KEYCHAIN`, or `IOS_PROVISION_PROFILES`" }, "file_chmod": { "type": "string", "description": "File permission set on copy to a container on each run. Set if `type` is `FILE`, `SSH_KEY`, `SSH_PUBLIC_KEY`, `IOS_KEYCHAIN`, or `IOS_PROVISION_PROFILES`" }, "file_place": { "type": "string", "description": "Set if `type` is `FILE`, `SSH_KEY`, `SSH_PUBLIC_KEY`, `IOS_KEYCHAIN`, or `IOS_PROVISION_PROFILES`. If it's `NONE`, the variable can be used as a parameter in an action. For `CONTAINER`, the given key is additionally copied to an action container on each run", "enum": [ "NONE", "CONTAINER" ] }, "password": { "type": "string", "description": "Password for certificates" }, "passphrase": { "type": "string", "description": "Passphrase for encrypted SSH keys" }, "key_identifier": { "type": "string", "description": "Key identifier for iOS certificates, provisioning profiles, or GPG keys" }, "disabled": { "type": "boolean", "description": "Set to `true` to disable the variable. Disabled variables are not injected anywhere" } } }, "VisualTestSuiteView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "string", "description": "Unique identifier of the visual test suite" }, "name": { "type": "string", "description": "Name of the visual test suite" }, "identifier": { "type": "string", "description": "Unique identifier for the suite (auto-generated if not provided)" }, "token": { "type": "string", "description": "Authentication token for the suite" } } }, "AddVisualTestSuiteRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the visual test suite" } } }, "ShortVisualTestSuiteView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "string", "description": "Unique identifier of the visual test suite" }, "name": { "type": "string", "description": "Name of the visual test suite" }, "identifier": { "type": "string", "description": "Unique identifier for the suite (auto-generated if not provided)" } } }, "VisualTestSuitesView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "suites": { "type": "array", "items": { "$ref": "#/components/schemas/ShortVisualTestSuiteView" } } } }, "WebhookRequestView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "post_date": { "type": "string", "description": "The timestamp when the webhook request was made", "format": "date-time" }, "response_status": { "type": "integer", "description": "The HTTP response code of the webhook request", "format": "int32" }, "body": { "type": "string", "description": "The request body sent to the webhook" } } }, "WebhookView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the webhook", "format": "int32" }, "target_url": { "type": "string", "description": "The URL to which the payload will be sent" }, "name": { "type": "string", "description": "The name of the webhook" }, "secret_key": { "type": "string", "description": "The value sent in the payload required by the webservice to validate the request" }, "projects": { "type": "array", "description": "The array of project name IDs from which webhooks will be executed", "items": { "type": "string" } }, "events": { "uniqueItems": true, "type": "array", "description": "Set of events that trigger the webhook", "items": { "type": "string", "enum": [ "DAY_CHANGED", "PUSH", "EXECUTION_STARTED", "EXECUTION_SUCCESSFUL", "EXECUTION_FAILED", "EXECUTION_FINISHED", "EXECUTION_PAUSED" ] } }, "requests": { "type": "array", "description": "Collection of recent webhook requests", "items": { "$ref": "#/components/schemas/WebhookRequestView" } } } }, "AddUpdateWebhookRequest": { "required": [ "events", "target_url" ], "type": "object", "properties": { "target_url": { "type": "string", "description": "The URL to which the payload will be sent" }, "secret_key": { "type": "string", "description": "The value sent in the payload required by the webservice to validate the request" }, "name": { "type": "string", "description": "The name of the webhook" }, "projects": { "type": "array", "description": "The array of project name IDs from which webhooks will be executed", "items": { "type": "string", "description": "The array of project name IDs from which webhooks will be executed" } }, "events": { "uniqueItems": true, "type": "array", "description": "Set of events that trigger the webhook", "items": { "type": "string", "description": "Set of events that trigger the webhook", "enum": [ "DAY_CHANGED", "PUSH", "EXECUTION_STARTED", "EXECUTION_SUCCESSFUL", "EXECUTION_FAILED", "EXECUTION_FINISHED", "EXECUTION_PAUSED" ] } } } }, "ShortWebhookView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the webhook", "format": "int32" }, "target_url": { "type": "string", "description": "The URL to which the payload will be sent" }, "name": { "type": "string", "description": "The name of the webhook" } } }, "WebhooksView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "webhooks": { "type": "array", "items": { "$ref": "#/components/schemas/ShortWebhookView" } } } }, "AddIntegrationRequest": { "required": [ "name", "scope", "type" ], "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" }, "name": { "type": "string", "description": "The name of the integration" }, "token": { "type": "string", "description": "The authentication token for services like GitHub, GitLab, DigitalOcean" }, "email": { "type": "string", "description": "Email address associated with the integration" }, "api_key": { "type": "string", "description": "The API key for services that use key-based authentication" }, "access_key": { "type": "string", "description": "The access key ID for AWS or DigitalOcean Spaces" }, "secret_key": { "type": "string", "description": "The secret access key for AWS or DigitalOcean Spaces" }, "partner_token": { "type": "string", "description": "Partner token for specific integrations" }, "shop": { "type": "string", "description": "The shop name for Shopify integrations" }, "url": { "type": "string", "description": "The integration URL" }, "chat_id": { "type": "string", "description": "The chat ID for messaging integrations" }, "git_hub_user_id": { "type": "string", "description": "The GitHub user ID" }, "git_hub_user_name": { "type": "string", "description": "The GitHub username" }, "username": { "type": "string", "description": "The username for authentication" }, "password": { "type": "string", "description": "The password for Azure Cloud, UpCloud, or DockerHub" }, "app_id": { "type": "string", "description": "The application ID for Azure Cloud integrations" }, "tenant_id": { "type": "string", "description": "The tenant ID for Azure Cloud integrations" }, "client_id": { "type": "string", "description": "The client ID for OAuth-based integrations" }, "client_token": { "type": "string", "description": "The client token for authentication" }, "server_id": { "type": "string", "description": "The server ID for Discord integrations" }, "server_token": { "type": "string", "description": "The server token for authentication" }, "key_id": { "type": "string", "description": "The key ID for various integrations" }, "application_key": { "type": "string", "description": "The application key for Datadog integrations" }, "host_url": { "type": "string", "description": "The host URL for custom integrations" }, "webhook_address": { "type": "string", "description": "The webhook URL for receiving notifications" }, "slack_user_id": { "type": "string", "description": "The Slack user ID" }, "region": { "type": "string", "description": "The cloud region (e.g., us-east-1, eu-west-1)" }, "role_assumptions": { "type": "array", "description": "AWS IAM role assumptions for cross-account access", "items": { "$ref": "#/components/schemas/RoleAssumptionView" } }, "all_pipelines_allowed": { "type": "boolean", "description": "Set to `true` to allow all pipelines to use this integration" }, "allowed_pipelines": { "type": "array", "description": "List of specific pipelines allowed to use this integration", "items": { "$ref": "#/components/schemas/PipelineIdView" } }, "permissions": { "$ref": "#/components/schemas/IntegrationPermissionsView" }, "auth_type": { "type": "string", "description": "The authentication method used by the integration", "enum": [ "OAUTH", "TOKEN", "API_KEY", "APP", "APP_SPRYKER", "TOKEN_APP_EXTENSION", "DEFAULT", "OIDC", "TRUSTED", "APP_RW" ] }, "target_url": { "type": "string", "description": "The target URL for webhook-based integrations" }, "refresh_token": { "type": "string", "description": "The refresh token for OAuth flows" }, "audience": { "type": "string", "description": "The JWT audience for token validation" }, "config": { "type": "string", "description": "Additional configuration data in JSON format" }, "google_project": { "type": "string", "description": "The Google Cloud project ID" }, "atop_url": { "type": "string", "description": "The ATOP service URL" }, "disabled": { "type": "boolean", "description": "Set to `true` to disable the integration. Disabled integrations cannot be used in actions" }, "type": { "type": "string", "description": "The type of integration", "enum": [ "GIT_HUB", "BITBUCKET", "GOOGLE", "DIGITAL_OCEAN", "SLACK", "MODULUS", "HEROKU", "AMAZON", "GIT_LAB", "SHOPIFY", "GIT_HUB_ENTERPRISE", "GIT_LAB_ENTERPRISE", "PUSHOVER", "PUSHBULLET", "RACKSPACE", "CUSTOM", "CLOUDFLARE", "NEW_RELIC", "SENTRY", "ROLLBAR", "DATADOG", "DO_SPACES", "HONEYBADGER", "VULTR", "SENTRY_ENTERPRISE", "LOGGLY", "HIP_CHAT", "FIREBASE", "TELEGRAM", "AZURE", "UPCLOUD", "GHOST_INSPECTOR", "NETLIFY", "AZURE_CLOUD", "MICROSOFT_TEAMS", "GOOGLE_SERVICE_ACCOUNT", "GOOGLE_PLAY_STORE", "DOCKER_HUB", "APP_STORE", "GIT_HUB_APP", "GIT_HUB_APP_ENTERPRISE", "GIT_HUB_API", "ATOP", "SNYK", "STACK_HAWK", "BLACKFIRE", "BACKBLAZE", "ONE_LOGIN", "OKTA", "CONTENTFUL", "JIRA", "NPM_REGISTRY", "ANTHROPIC" ] }, "scope": { "type": "string", "description": "The scope of the integration", "enum": [ "WORKSPACE", "PROJECT", "ENVIRONMENT" ] }, "project_name": { "type": "string", "description": "The human-readable ID of the project (required when scope is `PROJECT`)" } } }, "RoleAssumptionView": { "type": "object", "properties": { "arn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the AWS IAM role to assume" }, "external_id": { "type": "string", "description": "The external ID used for additional security when assuming the AWS role" }, "duration": { "type": "integer", "description": "The duration of the assumed role session in seconds", "format": "int32" } } }, "WorkspaceMemberView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the user", "format": "int32" }, "name": { "type": "string", "description": "The name of the user" }, "avatar_url": { "type": "string", "description": "The avatar URL of the user" }, "email": { "type": "string", "description": "The email address of the user" }, "admin": { "type": "boolean", "description": "Whether the user has admin privileges" }, "workspace_owner": { "type": "boolean", "description": "Whether the user is workspace owner" }, "auto_assign_to_new_projects": { "type": "boolean", "description": "Whether user is automatically assigned to new projects" }, "auto_assign_permission_set_id": { "type": "integer", "description": "ID of permission set to automatically assign to new projects", "format": "int32" } } }, "AddWorkspaceMemberRequest": { "required": [ "email" ], "type": "object", "properties": { "admin": { "type": "boolean", "description": "Whether the user has admin privileges" }, "auto_assign_to_new_projects": { "type": "boolean", "description": "Whether user is automatically assigned to new projects" }, "auto_assign_permission_set_id": { "type": "integer", "description": "ID of permission set to automatically assign to new projects", "format": "int32" }, "email": { "type": "string", "description": "The email address of the user" } } }, "IdsView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "domain": { "type": "string", "description": "The human-readable ID of the workspace" }, "project_identifier": { "type": "string", "description": "The human-readable ID of the project" }, "pipeline_id": { "type": "integer", "description": "The ID of the pipeline", "format": "int32" }, "environment_id": { "type": "string", "description": "The ID of the environment" }, "artifact_id": { "type": "string", "description": "The ID of the artifact" }, "artifact_version_id": { "type": "string", "description": "The ID of the artifact version" }, "sandbox_id": { "type": "string", "description": "The ID of the sandbox" }, "unit_test_suite_id": { "type": "string", "description": "The ID of the unit test suite" }, "visual_test_suite_id": { "type": "string", "description": "The ID of the visual test suite" }, "crawl_suite_id": { "type": "string", "description": "The ID of the crawl suite" }, "distribution_id": { "type": "string", "description": "The ID of the distribution" }, "route_id": { "type": "string", "description": "The ID of the route" } } }, "IntegrationsView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "integrations": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationView" } } } }, "SSOView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "type": { "type": "string", "description": "The type of the SSO to be set", "enum": [ "SAML", "OIDC" ] }, "sso_provider_type": { "type": "string", "description": "The provider type for SSO configuration", "enum": [ "OKTA", "ONE_LOGIN", "GOOGLE", "AZURE", "AWS", "CUSTOM" ] }, "sso_url": { "type": "string", "description": "The SSO URL / SAML endpoint / Identity provider Single sign-on URL. Set when type is `SAML`." }, "issuer": { "type": "string", "description": "Issuer URI, IDP Entity ID, SSO issuer, provider issuer, AD identifier or the base URL of the OpenID Connect (OIDC) server." }, "certificate": { "type": "string", "description": "The x509 certificate content. Set when type is `SAML`." }, "signature_method": { "type": "string", "description": "Set when type is `SAML`. Examples: `sha1`, `sha256`, `sha512`" }, "digest_method": { "type": "string", "description": "Set when type is `SAML`. Examples: `sha1`, `sha256`, `sha512`" }, "require_sso_for_all_members": { "type": "boolean", "description": "Require SSO authentication." } } }, "WorkspaceView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the workspace", "format": "int32" }, "name": { "type": "string", "description": "The name of the workspace" }, "domain": { "type": "string", "description": "The human-readable ID of the workspace. Alphanumeric characters, underscores, and hyphens (hyphens cannot appear at the start or end)." }, "owner_id": { "type": "integer", "description": "The ID of the workspace owner", "format": "int32" }, "frozen": { "type": "boolean", "description": "Whether the workspace is frozen" }, "create_date": { "type": "string", "description": "The date and time when the workspace was created", "format": "date-time" }, "default_pipeline_resource": { "type": "string", "description": "Default pipeline resource allocation for the workspace", "enum": [ "DEFAULT", "NANO", "SMALL", "MEDIUM", "LARGE", "XLARGE", "CUSTOM", "X2LARGE" ] }, "sso_enabled": { "type": "boolean", "description": "Whether Single Sign-On (SSO) is enabled for the workspace" }, "public_pipelines_disabled": { "type": "boolean", "description": "Whether public pipelines are disabled in the workspace" } } }, "WorkspaceMembersView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "members": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceMemberView" } } } }, "ShortWorkspaceView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "id": { "type": "integer", "description": "The ID of the workspace", "format": "int32" }, "name": { "type": "string", "description": "The name of the workspace" }, "domain": { "type": "string", "description": "The human-readable ID of the workspace. Alphanumeric characters, underscores, and hyphens (hyphens cannot appear at the start or end)." } } }, "WorkspacesView": { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint to GET this object", "readOnly": true }, "html_url": { "type": "string", "description": "Web URL to view this object in Buddy.works", "readOnly": true }, "workspaces": { "type": "array", "items": { "$ref": "#/components/schemas/ShortWorkspaceView" } } } }, "UpdateIntegrationRequest": { "required": [ "name" ], "type": "object", "properties": { "identifier": { "type": "string", "description": "A human-readable ID of the integration" }, "name": { "type": "string", "description": "The name of the integration" }, "token": { "type": "string", "description": "The authentication token for services like GitHub, GitLab, DigitalOcean" }, "email": { "type": "string", "description": "Email address associated with the integration" }, "api_key": { "type": "string", "description": "The API key for services that use key-based authentication" }, "access_key": { "type": "string", "description": "The access key ID for AWS or DigitalOcean Spaces" }, "secret_key": { "type": "string", "description": "The secret access key for AWS or DigitalOcean Spaces" }, "partner_token": { "type": "string", "description": "Partner token for specific integrations" }, "shop": { "type": "string", "description": "The shop name for Shopify integrations" }, "url": { "type": "string", "description": "The integration URL" }, "chat_id": { "type": "string", "description": "The chat ID for messaging integrations" }, "git_hub_user_id": { "type": "string", "description": "The GitHub user ID" }, "git_hub_user_name": { "type": "string", "description": "The GitHub username" }, "username": { "type": "string", "description": "The username for authentication" }, "password": { "type": "string", "description": "The password for Azure Cloud, UpCloud, or DockerHub" }, "app_id": { "type": "string", "description": "The application ID for Azure Cloud integrations" }, "tenant_id": { "type": "string", "description": "The tenant ID for Azure Cloud integrations" }, "client_id": { "type": "string", "description": "The client ID for OAuth-based integrations" }, "client_token": { "type": "string", "description": "The client token for authentication" }, "server_id": { "type": "string", "description": "The server ID for Discord integrations" }, "server_token": { "type": "string", "description": "The server token for authentication" }, "key_id": { "type": "string", "description": "The key ID for various integrations" }, "application_key": { "type": "string", "description": "The application key for Datadog integrations" }, "host_url": { "type": "string", "description": "The host URL for custom integrations" }, "webhook_address": { "type": "string", "description": "The webhook URL for receiving notifications" }, "slack_user_id": { "type": "string", "description": "The Slack user ID" }, "region": { "type": "string", "description": "The cloud region (e.g., us-east-1, eu-west-1)" }, "role_assumptions": { "type": "array", "description": "AWS IAM role assumptions for cross-account access", "items": { "$ref": "#/components/schemas/RoleAssumptionView" } }, "all_pipelines_allowed": { "type": "boolean", "description": "Set to `true` to allow all pipelines to use this integration" }, "allowed_pipelines": { "type": "array", "description": "List of specific pipelines allowed to use this integration", "items": { "$ref": "#/components/schemas/PipelineIdView" } }, "permissions": { "$ref": "#/components/schemas/IntegrationPermissionsView" }, "auth_type": { "type": "string", "description": "The authentication method used by the integration", "enum": [ "OAUTH", "TOKEN", "API_KEY", "APP", "APP_SPRYKER", "TOKEN_APP_EXTENSION", "DEFAULT", "OIDC", "TRUSTED", "APP_RW" ] }, "target_url": { "type": "string", "description": "The target URL for webhook-based integrations" }, "refresh_token": { "type": "string", "description": "The refresh token for OAuth flows" }, "audience": { "type": "string", "description": "The JWT audience for token validation" }, "config": { "type": "string", "description": "Additional configuration data in JSON format" }, "google_project": { "type": "string", "description": "The Google Cloud project ID" }, "atop_url": { "type": "string", "description": "The ATOP service URL" }, "disabled": { "type": "boolean", "description": "Set to `true` to disable the integration. Disabled integrations cannot be used in actions" } } }, "UpdateSSORequest": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of the SSO to be set", "enum": [ "SAML", "OIDC" ] }, "sso_provider_type": { "type": "string", "description": "The provider type for SSO configuration", "enum": [ "OKTA", "ONE_LOGIN", "GOOGLE", "AZURE", "AWS", "CUSTOM" ] }, "sso_url": { "type": "string", "description": "The SSO URL / SAML endpoint / Identity provider Single sign-on URL. Set when type is `SAML`." }, "issuer": { "type": "string", "description": "Issuer URI, IDP Entity ID, SSO issuer, provider issuer, AD identifier or the base URL of the OpenID Connect (OIDC) server." }, "certificate": { "type": "string", "description": "The x509 certificate content. Set when type is `SAML`." }, "signature_method": { "type": "string", "description": "Set when type is `SAML`. Examples: `sha1`, `sha256`, `sha512`" }, "digest_method": { "type": "string", "description": "Set when type is `SAML`. Examples: `sha1`, `sha256`, `sha512`" }, "client_id": { "type": "string", "description": "The client ID of the identity provider application." }, "client_secret": { "type": "string", "description": "The client secret of the identity provider application." }, "require_sso_for_all_members": { "type": "boolean", "description": "Require SSO authentication." } } }, "UpdateWorkspaceMemberRequest": { "type": "object", "properties": { "admin": { "type": "boolean", "description": "Whether the user has admin privileges" }, "auto_assign_to_new_projects": { "type": "boolean", "description": "Whether user is automatically assigned to new projects" }, "auto_assign_permission_set_id": { "type": "integer", "description": "ID of permission set to automatically assign to new projects", "format": "int32" } } }, "EntityTag": { "type": "object", "properties": { "value": { "type": "string" }, "weak": { "type": "boolean" } } }, "Link": { "type": "object", "properties": { "type": { "type": "string" }, "uri": { "type": "string", "format": "uri" }, "uri_builder": { "$ref": "#/components/schemas/UriBuilder" }, "rel": { "type": "string" }, "rels": { "type": "array", "items": { "type": "string" } }, "params": { "type": "object", "additionalProperties": { "type": "string" } }, "title": { "type": "string" } } }, "NewCookie": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "version": { "type": "integer", "format": "int32" }, "path": { "type": "string" }, "domain": { "type": "string" }, "comment": { "type": "string" }, "max_age": { "type": "integer", "format": "int32" }, "expiry": { "type": "string", "format": "date-time" }, "secure": { "type": "boolean" }, "http_only": { "type": "boolean" }, "same_site": { "type": "string", "enum": [ "NONE", "LAX", "STRICT" ] } } }, "Response": { "type": "object", "properties": { "length": { "type": "integer", "format": "int32" }, "location": { "type": "string", "format": "uri" }, "language": { "type": "object", "properties": { "language": { "type": "string" }, "display_name": { "type": "string" }, "country": { "type": "string" }, "variant": { "type": "string" }, "script": { "type": "string" }, "unicode_locale_attributes": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "unicode_locale_keys": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "display_language": { "type": "string" }, "display_script": { "type": "string" }, "display_country": { "type": "string" }, "display_variant": { "type": "string" }, "extension_keys": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "iso3_language": { "type": "string" }, "iso3_country": { "type": "string" } } }, "date": { "type": "string", "format": "date-time" }, "last_modified": { "type": "string", "format": "date-time" }, "allowed_methods": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "status_info": { "$ref": "#/components/schemas/StatusType" }, "cookies": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/NewCookie" } }, "links": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Link" } }, "media_type": { "$ref": "#/components/schemas/MediaType" }, "entity_tag": { "$ref": "#/components/schemas/EntityTag" }, "string_headers": { "type": "object", "properties": { "empty": { "type": "boolean" } }, "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "headers": { "type": "object", "properties": { "empty": { "type": "boolean" } }, "additionalProperties": { "type": "array", "items": { "type": "object" } } }, "closed": { "type": "boolean" }, "status": { "type": "integer", "format": "int32" }, "metadata": { "type": "object", "properties": { "empty": { "type": "boolean" } }, "additionalProperties": { "type": "array", "items": { "type": "object" } } }, "entity": { "type": "object" } } }, "StatusType": { "type": "object", "properties": { "family": { "type": "string", "enum": [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] }, "status_code": { "type": "integer", "format": "int32" }, "reason_phrase": { "type": "string" } } }, "UriBuilder": { "type": "object" } }, "securitySchemes": { "oauth2": { "type": "oauth2", "flows": { "authorizationCode": { "authorizationUrl": "https://app.buddy.works/oauth2/authorize", "tokenUrl": "https://app.buddy.works/oauth2/token", "scopes": { "WORKSPACE": "Access to basic workspace information as well as the rights to manage members, groups and member permissions", "PROJECT_DELETE": "Permission to delete projects", "MEMBER_EMAIL": "Access to contact info of workspace members", "MANAGE_EMAILS": "Permission to view and manage user email addresses (contains USER_EMAIL rights)", "REPOSITORY_READ": "Access to commits and repository content. Repository checkout is allowed, too", "REPOSITORY_WRITE": "Permission to write in the repository. File deletion is allowed, too (contains REPOSITORY_READ rights)", "EXECUTION_INFO": "Access to executions history", "EXECUTION_RUN": "Permission to run and stop executions (contains EXECUTION_INFO rights)", "EXECUTION_MANAGE": "Permission to add/edit pipelines (contains EXECUTION_RUN rights)", "ENVIRONMENT_INFO": "Access to environment info", "ENVIRONMENT_ADD": "Permission to get and add environment", "ENVIRONMENT_MANAGE": "Permission to add/edit and delete environment", "TARGET_INFO": "Access to target info", "TARGET_ADD": "Permission to get and add target", "TARGET_MANAGE": "Permission to add/edit and delete target", "ZONE_READ": "Access to the domains info", "ZONE_WRITE": "Permission to add/edit/delete domain's records", "ZONE_MANAGE": "Permission to manage domains", "WEBHOOK_INFO": "Access to webhooks info", "WEBHOOK_ADD": "Permission to get and add webhooks", "WEBHOOK_MANAGE": "Permission to add/edit and delete webhooks", "VARIABLE_INFO": "Access to environment variables' info", "VARIABLE_ADD": "Permission to get and add environment variables", "VARIABLE_MANAGE": "Permission to add/edit and delete environment variables", "USER_INFO": "Access to base information of the authorized user", "USER_KEY": "Access to public SSH keys of authorized user", "USER_EMAIL": "Access to email list of authorized user", "INTEGRATION_INFO": "Access to the list of integrations available to the authorized user", "INTEGRATION_ADD": "Permission to get and add integrations", "INTEGRATION_MANAGE": "Permission to manage integrations", "TOKEN_INFO": "Access to personal access tokens info", "TOKEN_MANAGE": "Permission to add and delete personal access tokens", "SANDBOX_INFO": "Access to sandboxes info", "SANDBOX_MANAGE": "Permission to add/edit and delete sandboxes", "ARTIFACT_READ": "Access to artifacts info", "ARTIFACT_WRITE": "Permission to get and add artifacts", "ARTIFACT_MANAGE": "Permission to add/edit and delete artifacts", "DISTRIBUTION_INFO": "Access to distributions and routes info", "DISTRIBUTION_ADD": "Permission to get and add distributions and routes", "DISTRIBUTION_MANAGE": "Permission to add/edit and delete distributions and routes", "UNIT_TEST_INFO": "Access to unit tests info", "UNIT_TEST_MANAGE": "Permission to add/edit and delete unit tests" } } } } } }, "x-generated-at": 1779197440 }