Skip to main content
POST
/
api
/
deploy
/
project
Deploy project
curl --request POST \
  --url https://app.prophecy.io/api/deploy/project \
  --header 'Content-Type: application/json' \
  --header 'X-AUTH-TOKEN: <x-auth-token>' \
  --data '
{
  "projectName": "CustomerAnalytics",
  "fabricName": "production-databricks",
  "gitTag": "CustomerAnalytics/2.1",
  "pipelineConfigurations": {
    "sales_report": {
      "report_period": "monthly",
      "include_forecasts": "true"
    },
    "customer_segmentation": {
      "segment_count": "5",
      "min_customers_per_segment": "100"
    },
    "revenue_analysis": {
      "currency": "USD",
      "include_tax": "false"
    }
  },
  "projectConfiguration": {
    "environment": "production",
    "data_refresh_frequency": "daily"
  }
}
'
{
  "success": true,
  "message": "Project scheduled successfully",
  "deploymentId": "212",
  "details": {
    "projectId": "67890",
    "fabricId": "09123",
    "version": "2.1",
    "pipelinesDeployed": [
      "sales_report",
      "customer_segmentation",
      "revenue_analysis"
    ],
    "configurationsApplied": 5
  }
}

​
Requirements

To run the API, you need to:
  • Reference a fabric that exists in your environment.
  • Use an existing Git tag that defines the project version.
Unlike in the Prophecy UI where Git tags are created automatically during publish, when using this API you must create the Git tag externally.The tag must follow the exact format {projectName}/{version}.

​
Parameter Precedence

Configuration parameters follow this precedence order:
  1. Pipeline parameter overrides (highest priority)
  2. Project configuration overrides
  3. Default pipeline parameters
  4. Default project configuration (lowest priority)

Headers

​
X-AUTH-TOKEN
string
required

Prophecy access token

Body

application/json

Project deployment parameters

​
projectName
string
required

Name of the project to be deployed. Example: CustomerAnalytics

​
fabricName
string
required

Name of the fabric where the project will be deployed. Example: production-databricks

​
gitTag
string
required

Git tag identifying the specific version of the project to deploy. Must follow the format {projectName}/{version}.

​
pipelineConfigurations
object

Override default values for specific pipeline parameters. Each pipeline can have multiple parameter overrides. The parameter must exist in the pipeline definition, or the override will be skipped.

You only need to specify the parameters you want to override. Any parameters not specified will use their default values from the pipeline definition. You can override just one parameter or multiple parameters as needed.

​
projectConfiguration
object

Override default values for project-level configuration parameters that apply to all pipelines in the project.

Response

200 - application/json

Project deployment response

​
success
boolean

Indicates whether the request to deploy the project was successful.

​
message
string

Message that explains the outcome of the request.

​
deploymentId
string

Unique identifier of the deployment generated by this request.

​
details
object
​
error
string

Detailed error information provided when the request fails.