• Document Up to Date
  • Updated On 4.0.0

Deploy Target

Deploy a Crafter Deployer target.

Resource Information

This service uses the deployer application on port 9191 by default. To see a list of default ports click here

The context for this API is /.

HTTP Verb
POST
URL
/api/1/target/deploy/:env/:site_name
Response Formats
JSON

Parameters

Name Type Required Description
env String The target’s environment (e.g dev).
site_name Boolean The target’s project name (e.g my-editorial).
reprocess_all_files Boolean   If all files in all the target repos should be reprocessed.

from_commit_id

Since 4.0.0
String   The id of the commit to start processing changes

deployment_mode

Since 4.0.0
String   The deployment mode to execute. Possible values:
PUBLISH: All processors will run
SEARCH_INDEX: Only the indexing processor will run

Example

Request

POST .../api/1/target/deploy/dev/mysite

{
  "reprocess_all_files": false
}

Response

Status 202 OK

Responses

Status
Location
Response Body
202

See example above
404

{ "message" : "Target not found" }
500

{ "message" : "Internal server error" }