Get Site
Get 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
|
GET
|
URL
|
/api/1/services/api/1/site/get.json |
Response Formats
|
JSON |
Required Role
|
Admin, member in the site
|
Parameters
Name
|
Type
|
Required
|
Description
|
|---|---|---|---|
site_id
|
String
|
✓
|
Site ID to use
|
Example
GET .../api/1/services/api/1/site/get.json?site_id=my-site
{
"site_id" : "my-site",
"description" : "My very first site!",
"blueprint" : "empty"
}
Response
Status
|
Location
|
Response Body
|
|---|---|---|
200
|
.../site/get.json?site_id=my-site |
See example above.
|
400
|
{ "message" : "Invalid parameter(s)" } |
|
401
|
{ "message" : "Unauthorized" } |
|
404
|
{ "message" : "Site not found" } |
|
500
|
{ "message" : "Internal server error" } |