• Document Up to Date

Remove Remote (deprecated)

Remove remote repository from site content repository.

Important

This API is deprecated and provided only as a reference. Please see removeRemoteRepository for the current version.

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/repo/remove-remote.json
Response Formats
JSON
Required Role
Admin, site admin

Parameters

Name
Type
Required
Description
site_id
String
Site to use
remote_name
String
Remote repository name

Example

Request

POST .../api/1/services/api/1/repo/remove-remote.json

{
  "site_id" : "mysite",
  "remote_name" : "origin"
}

Response

Status 200 OK

null

Responses

Status
Location
Response Body
204


400

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

{ "message" : "Bad Request" }
401

{ "message" : "Unauthorized" }
404

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

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

{ "message" : "Internal server error" }