Skip to main content
POST
/
job
/
{job_id}
/
deployed
Report the final deployed URL
curl --request POST \
  --url https://{host}/api/sharesame/job/{job_id}/deployed \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "deployment_id": "deploy_123",
  "deploy_url": "https://forcesale.example.com"
}
'
import requests

url = "https://{host}/api/sharesame/job/{job_id}/deployed"

payload = {
"deployment_id": "deploy_123",
"deploy_url": "https://forcesale.example.com"
}
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({deployment_id: 'deploy_123', deploy_url: 'https://forcesale.example.com'})
};

fetch('https://{host}/api/sharesame/job/{job_id}/deployed', 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://{host}/api/sharesame/job/{job_id}/deployed",
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([
'deployment_id' => 'deploy_123',
'deploy_url' => 'https://forcesale.example.com'
]),
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://{host}/api/sharesame/job/{job_id}/deployed"

payload := strings.NewReader("{\n \"deployment_id\": \"deploy_123\",\n \"deploy_url\": \"https://forcesale.example.com\"\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://{host}/api/sharesame/job/{job_id}/deployed")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"deployment_id\": \"deploy_123\",\n \"deploy_url\": \"https://forcesale.example.com\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{host}/api/sharesame/job/{job_id}/deployed")

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 \"deployment_id\": \"deploy_123\",\n \"deploy_url\": \"https://forcesale.example.com\"\n}"

response = http.request(request)
puts response.read_body
{
  "ok": true
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

job_id
string
required

Body

application/json
deployment_id
string

Optional deployment identifier from your own system

deploy_url
string

Final public URL for the deployed website

Response

200 - application/json

Report accepted

ok
boolean
required