Stop Publisher¶
Stop Crafter Studio’s publishing for a 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/publish/stop.json |
Response Formats
|
JSON |
Required Role
|
Admin, Site Admin.
|
Parameters¶
Name
|
Type
|
Required
|
Description
|
|---|---|---|---|
site_id
|
String
|
✓
|
Site ID to use
|
Example¶
Request¶
POST .../api/1/publish/stop.json?site_id=my-site
{
"site_id" : "my-site"
}
Response¶
Status 200 OK
{
"message" : "OK"
}
Responses¶
Status
|
Response Body
|
|---|---|
200
|
{ "message" : "OK" } |
400
|
{ "message" : "Invalid parameter(s)" } |
400
|
{ "message" : "Bad Request" } |
401
|
{ "message" : "Unauthorized" } |
404
|
{ "message" : "Site not found" } |
500
|
{ "message" : "Internal server error.ACTUAL_EXCEPTION" } |