curl --request POST \
--url https://app.sandywp.com/api/app/sites/{id}/repositories \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"repoUrl": "https://github.com/you/my-plugin.git",
"folderName": "my-plugin",
"branch": "<string>",
"isPrivate": true,
"autoDeploy": true
}
'import requests
url = "https://app.sandywp.com/api/app/sites/{id}/repositories"
payload = {
"repoUrl": "https://github.com/you/my-plugin.git",
"folderName": "my-plugin",
"branch": "<string>",
"isPrivate": True,
"autoDeploy": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
repoUrl: 'https://github.com/you/my-plugin.git',
folderName: 'my-plugin',
branch: '<string>',
isPrivate: true,
autoDeploy: true
})
};
fetch('https://app.sandywp.com/api/app/sites/{id}/repositories', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.sandywp.com/api/app/sites/{id}/repositories",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'repoUrl' => 'https://github.com/you/my-plugin.git',
'folderName' => 'my-plugin',
'branch' => '<string>',
'isPrivate' => true,
'autoDeploy' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.sandywp.com/api/app/sites/{id}/repositories"
payload := strings.NewReader("{\n \"repoUrl\": \"https://github.com/you/my-plugin.git\",\n \"folderName\": \"my-plugin\",\n \"branch\": \"<string>\",\n \"isPrivate\": true,\n \"autoDeploy\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.sandywp.com/api/app/sites/{id}/repositories")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"repoUrl\": \"https://github.com/you/my-plugin.git\",\n \"folderName\": \"my-plugin\",\n \"branch\": \"<string>\",\n \"isPrivate\": true,\n \"autoDeploy\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.sandywp.com/api/app/sites/{id}/repositories")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"repoUrl\": \"https://github.com/you/my-plugin.git\",\n \"folderName\": \"my-plugin\",\n \"branch\": \"<string>\",\n \"isPrivate\": true,\n \"autoDeploy\": true\n}"
response = http.request(request)
puts response.read_body{
"repository": {
"id": "repo_1",
"siteId": "<string>",
"repoUrl": "<string>",
"branch": "<string>",
"destination": "plugin",
"folderName": "<string>",
"authKind": "https",
"deployKeyPublic": "<string>",
"autoDeploy": true,
"lastDeployedSha": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"webhookUrl": "<string>"
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "auth_required",
"message": "A logged-in user is required.",
"details": {}
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "site_not_found",
"message": "Site not found.",
"details": {}
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": {}
}
}Connect a Git repository for deploys
Connects a Git repository to a sandbox for deploys. Private repos need an SSH URL; add the returned deployKeyPublic as a deploy key on the git host. A sandbox may have only one connected repository at a time (409 repository_limit). Only available on account-owned (not guest) sandboxes.
curl --request POST \
--url https://app.sandywp.com/api/app/sites/{id}/repositories \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"repoUrl": "https://github.com/you/my-plugin.git",
"folderName": "my-plugin",
"branch": "<string>",
"isPrivate": true,
"autoDeploy": true
}
'import requests
url = "https://app.sandywp.com/api/app/sites/{id}/repositories"
payload = {
"repoUrl": "https://github.com/you/my-plugin.git",
"folderName": "my-plugin",
"branch": "<string>",
"isPrivate": True,
"autoDeploy": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
repoUrl: 'https://github.com/you/my-plugin.git',
folderName: 'my-plugin',
branch: '<string>',
isPrivate: true,
autoDeploy: true
})
};
fetch('https://app.sandywp.com/api/app/sites/{id}/repositories', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.sandywp.com/api/app/sites/{id}/repositories",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'repoUrl' => 'https://github.com/you/my-plugin.git',
'folderName' => 'my-plugin',
'branch' => '<string>',
'isPrivate' => true,
'autoDeploy' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.sandywp.com/api/app/sites/{id}/repositories"
payload := strings.NewReader("{\n \"repoUrl\": \"https://github.com/you/my-plugin.git\",\n \"folderName\": \"my-plugin\",\n \"branch\": \"<string>\",\n \"isPrivate\": true,\n \"autoDeploy\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.sandywp.com/api/app/sites/{id}/repositories")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"repoUrl\": \"https://github.com/you/my-plugin.git\",\n \"folderName\": \"my-plugin\",\n \"branch\": \"<string>\",\n \"isPrivate\": true,\n \"autoDeploy\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.sandywp.com/api/app/sites/{id}/repositories")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"repoUrl\": \"https://github.com/you/my-plugin.git\",\n \"folderName\": \"my-plugin\",\n \"branch\": \"<string>\",\n \"isPrivate\": true,\n \"autoDeploy\": true\n}"
response = http.request(request)
puts response.read_body{
"repository": {
"id": "repo_1",
"siteId": "<string>",
"repoUrl": "<string>",
"branch": "<string>",
"destination": "plugin",
"folderName": "<string>",
"authKind": "https",
"deployKeyPublic": "<string>",
"autoDeploy": true,
"lastDeployedSha": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"webhookUrl": "<string>"
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "auth_required",
"message": "A logged-in user is required.",
"details": {}
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "site_not_found",
"message": "Site not found.",
"details": {}
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": {}
}
}Authorizations
Personal API token, sent as Authorization: Bearer <SANDYWP_API_KEY>. Obtain one from the dashboard account menu (API keys), sandywp auth login, or POST /api/account/tokens. A missing or invalid token returns 401 auth_required. Scoped OAuth tokens are limited to the Imports family and GET /api/account/me; see the top-level conventions.
Headers
Selects which of the caller's workspaces to act in, for accounts belonging to more than one (legacy alias: X-SandyWP-Organization). Defaults to the caller's own personal workspace when omitted. Every id in this API (sandboxes, Templates, repositories) is scoped to a single workspace, so this header changes which set of resources is visible.
Path Parameters
The sandbox id.
Body
Required. https:// URL with no embedded credentials for a public repo, or an SSH URL (git@host:owner/repo.git or ssh://git@host/owner/repo.git) for a private one — which grammar is enforced depends on isPrivate.
"https://github.com/you/my-plugin.git"
Required. Where inside wp-content the repository is synced: plugin → wp-content/plugins/<folderName>, theme → wp-content/themes/<folderName>, wp_content → wp-content/<folderName>.
plugin, theme, wp_content Required. A single path segment (no slashes) under the destination — the target folder name.
^[A-Za-z0-9][A-Za-z0-9._-]{0,99}$"my-plugin"
Branch to deploy. Defaults to main.
^[A-Za-z0-9][A-Za-z0-9._/-]{0,200}$Whether the repo is private. When true, a per-repository SSH deploy key is generated. Defaults to false.
Deploy automatically on push, via the returned webhookUrl. Defaults to false.
Response
The connected repository and its webhook URL.
The owner-facing view of a connected Git repository. Strips the webhook secret — the plaintext webhook URL is only ever returned once, at connect time.
Show child attributes
Show child attributes
One-time-shown URL (carries an opaque token) to configure as the git host's push webhook for autoDeploy.

