Create Site
Create a Crafter Studio site.
Resource Information
This service uses the tomcat application on port 8080 by default. To see a list of default ports click here
The context for this API is /studio, please prefix the API URLs with this context.
HTTP Verb
|
POST
|
URL
|
/api/1/services/api/1/site/create.json |
Response Formats
|
JSON |
Required Role
|
Admin
|
Parameters
Name
|
Type
|
Required
|
Description
|
|---|---|---|---|
site_id
|
String
|
✓
|
Site ID to use
|
name
|
String
|
✓
|
Label to use for the site
|
sandbox_branch
|
String
|
Name for sandbox branch (default master)
|
|
description
|
String
|
Site description
|
|
blueprint
|
String
|
✓ *
|
Blueprint to use for bootstrapping the site
|
use_remote
|
Boolean
|
✓ *
|
Use remote repository option if true, otherwise false
|
remote_name
|
String
|
Remote repository name (default origin)
|
|
remote_url
|
String
|
✓ *
|
Remote repository url
|
remote_branch
|
String
|
Branch to clone repo from
|
|
single_branch
|
Boolean
|
Clone single branch if true, otherwise clone all
|
|
authentication_type
|
String
|
✓ *
|
Authentication type to use to access remote repository
none: No authenticationbasic: username password authenticationtoken: username token authenticationkey: key-based authentication |
remote_username
|
String
|
✓ *
|
Username to access remote repository
|
remote_password
|
String
|
✓ *
|
Password to access remote repository
|
remote_token
|
String
|
✓ *
|
Token to use to access remote repository
|
remote_private_key
|
String
|
✓ *
|
Private key to access remote repository
|
create_option
|
String
|
✓ *
|
Create options for remote repository:
clone: clone from remote repository |
site_params
|
Object
|
Object containing all parameters for the blueprint. It
should include all required parameters from the descriptor
|
|
create_as_orphan
|
Boolean
|
Create the site from a remote repository as orphan
(no git history) - default is false
|
Note
*Required parameters:some remote parameters are required if
use_remoteis trueblueprintis required ifuse_remoteis falseauthentication_typeis required ifauthentication_typeto be used is notnoneremote_usernameis required ifauthentication_typeis set tobasicremote_passwordis required ifauthentication_typeis set tobasicremote_tokenis required ifauthentication_typeis set totokenremote_private_keyis required ifauthentication_typeis set tokey
Example
Create a site
Example of creating a site:
POST .../api/1/services/api/1/site/create.json
{
"site_id" : "my-site",
"description" : "My very first site!",
"blueprint" : "org.craftercms.blueprint.empty"
}
Response
Status
|
Location
|
Response Body
|
|---|---|---|
201
|
.../site/get.json?site_id=:site_id |
{ "message" : "OK" } |
400
|
{ "message" : "Invalid parameter(s)" } |
|
400
|
{ "message" : "Bad Request" } |
|
400
|
{ "message" : "Remote repository URL invalid" } |
|
400
|
{ "message" : "Remote branch does not exist" } |
|
400
|
{ "message" : "Bad credentials or read only repository" } |
|
400
|
{ "message" : "Invalid create option for remote repository" } |
|
401
|
{ "message" : "Unauthorized" } |
|
404
|
{ "message" : "Blueprint not found" } |
|
404
|
{ "message" : "Remote repository not found" } |
|
409
|
.../site/get.json?site_id=:site_id |
{ "message" : "Site already exists" } |
409
|
{ "message" : "Remote repository is not bare" } |
|
500
|
{ "message" : "Internal server error" } |