• Document Up to Date

Publish Commits

Publish commits from sandbox repository by commit id.

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/commits.json
Response Formats
JSON
Required Role
N/A

Parameters

Name
Type
Required
Description
site_id
String
Site to use
environment
String
Environment to deploy content
commit_ids
String
List of commit ids to publish
comment
String

Submission commit

Example

Request

POST .../api/1/services/api/1/publish/commits.json
{
    "site_id" : "mysite",
    "environment": "live"
    "commit_ids" :
        [
            "c89ee1cb2be4b41b0966d20c12d53b68ca70d74a",
            "0664df1ad04a9627dccb55a51ebf3704e313e40b",
            "93ae0e5e8d084fa9b7723cf3cf7ce526f47af0a9"
        ],
    "comment" : "my submission comment"
}

Response

Status
Location
Response Body
200

{ "message" : "OK" }
400

{ "message" : "Invalid parameter(s)" }
400

{ "message" : "Bad Request" }
401

{ "message" : "Unauthorized" }
404

{ "message" : "Site not found" }
404

{ "message" : "Environment not found" }
404

{ "message" : "Commit(s) not found" }
500

{ "message" : "Internal server error" }