Skip to content
Nexa Platform Docs

Execute Files Batch

POST
/api/v1/deployments/execute-batch
curl --request POST \
  --url 'https://example.com/api/v1/deployments/execute-batch?repository_name=example&branch=main&file_paths=example&deployment_id=example&on_error=break' \
  --header 'Content-Type: application/json' \
  --data '{ "additionalProperty": "example" }'

Execute multiple files in batch.

Executes a list of SQL files in the specified order. Can either stop on first error (break) or continue through all files (continue).

Args: repository_name: Git repository name branch: Branch name file_paths: List of file paths to execute variables: Optional template variables on_error: ‘break’ to stop on error, ‘continue’ to execute all

Returns: Dictionary with execution results for each file

Raises: HTTPException: If batch execution fails

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
repository_name
required
Repository Name

Git repository name

string

Git repository name

branch
Branch

Branch name

string
default: main

Branch name

file_paths
required
File Paths

List of file paths to execute

Array<string>

List of file paths to execute

deployment_id
required
Deployment Id

Deployment ID

string

Deployment ID

on_error
On Error

Error handling: ‘break’ or ‘continue’

string
default: break

Error handling: ‘break’ or ‘continue’

Header Parameters

Section titled “Header Parameters”
X-Environment-Id
Any of:
string

Request Body

Section titled “Request Body”
Media typeapplication/json
Any of:
object
key
additional properties
Any of:
string
Examplegenerated
{
  "additionalProperty": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Response Execute Files Batch Api V1 Deployments Execute Batch Post
object
key
additional properties
Any of:
Array
Examplegenerated
{
  "additionalProperty": [
    "example"
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}