Partially update a payload
curl --request PATCH \
--url https://api.valar.space/operations/spacecraft/{spacecraftId}/payloads/{payloadId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"boresight": "Z+",
"focalLengthMm": 123,
"fovShape": "CONICAL",
"halfAngleDeg": 30,
"halfHeightDeg": 20,
"halfWidthDeg": 10,
"name": "EO Camera",
"offNadirAlongTrackDeg": 123,
"offNadirCrossTrackDeg": 123,
"pixelPitchUm": 123,
"positionX": 0.1,
"positionY": 0,
"positionZ": -0.2,
"radiusDeg": 30,
"sides": 6
}
'import requests
url = "https://api.valar.space/operations/spacecraft/{spacecraftId}/payloads/{payloadId}"
payload = {
"boresight": "Z+",
"focalLengthMm": 123,
"fovShape": "CONICAL",
"halfAngleDeg": 30,
"halfHeightDeg": 20,
"halfWidthDeg": 10,
"name": "EO Camera",
"offNadirAlongTrackDeg": 123,
"offNadirCrossTrackDeg": 123,
"pixelPitchUm": 123,
"positionX": 0.1,
"positionY": 0,
"positionZ": -0.2,
"radiusDeg": 30,
"sides": 6
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
boresight: 'Z+',
focalLengthMm: 123,
fovShape: 'CONICAL',
halfAngleDeg: 30,
halfHeightDeg: 20,
halfWidthDeg: 10,
name: 'EO Camera',
offNadirAlongTrackDeg: 123,
offNadirCrossTrackDeg: 123,
pixelPitchUm: 123,
positionX: 0.1,
positionY: 0,
positionZ: -0.2,
radiusDeg: 30,
sides: 6
})
};
fetch('https://api.valar.space/operations/spacecraft/{spacecraftId}/payloads/{payloadId}', 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://api.valar.space/operations/spacecraft/{spacecraftId}/payloads/{payloadId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'boresight' => 'Z+',
'focalLengthMm' => 123,
'fovShape' => 'CONICAL',
'halfAngleDeg' => 30,
'halfHeightDeg' => 20,
'halfWidthDeg' => 10,
'name' => 'EO Camera',
'offNadirAlongTrackDeg' => 123,
'offNadirCrossTrackDeg' => 123,
'pixelPitchUm' => 123,
'positionX' => 0.1,
'positionY' => 0,
'positionZ' => -0.2,
'radiusDeg' => 30,
'sides' => 6
]),
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://api.valar.space/operations/spacecraft/{spacecraftId}/payloads/{payloadId}"
payload := strings.NewReader("{\n \"boresight\": \"Z+\",\n \"focalLengthMm\": 123,\n \"fovShape\": \"CONICAL\",\n \"halfAngleDeg\": 30,\n \"halfHeightDeg\": 20,\n \"halfWidthDeg\": 10,\n \"name\": \"EO Camera\",\n \"offNadirAlongTrackDeg\": 123,\n \"offNadirCrossTrackDeg\": 123,\n \"pixelPitchUm\": 123,\n \"positionX\": 0.1,\n \"positionY\": 0,\n \"positionZ\": -0.2,\n \"radiusDeg\": 30,\n \"sides\": 6\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.valar.space/operations/spacecraft/{spacecraftId}/payloads/{payloadId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"boresight\": \"Z+\",\n \"focalLengthMm\": 123,\n \"fovShape\": \"CONICAL\",\n \"halfAngleDeg\": 30,\n \"halfHeightDeg\": 20,\n \"halfWidthDeg\": 10,\n \"name\": \"EO Camera\",\n \"offNadirAlongTrackDeg\": 123,\n \"offNadirCrossTrackDeg\": 123,\n \"pixelPitchUm\": 123,\n \"positionX\": 0.1,\n \"positionY\": 0,\n \"positionZ\": -0.2,\n \"radiusDeg\": 30,\n \"sides\": 6\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.valar.space/operations/spacecraft/{spacecraftId}/payloads/{payloadId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"boresight\": \"Z+\",\n \"focalLengthMm\": 123,\n \"fovShape\": \"CONICAL\",\n \"halfAngleDeg\": 30,\n \"halfHeightDeg\": 20,\n \"halfWidthDeg\": 10,\n \"name\": \"EO Camera\",\n \"offNadirAlongTrackDeg\": 123,\n \"offNadirCrossTrackDeg\": 123,\n \"pixelPitchUm\": 123,\n \"positionX\": 0.1,\n \"positionY\": 0,\n \"positionZ\": -0.2,\n \"radiusDeg\": 30,\n \"sides\": 6\n}"
response = http.request(request)
puts response.read_body{
"boresight": "X+",
"focalLengthMm": 123,
"fovShape": "CONICAL",
"halfAngleDeg": 123,
"halfHeightDeg": 123,
"halfWidthDeg": 123,
"id": "<string>",
"name": "<string>",
"offNadirAlongTrackDeg": 123,
"offNadirCrossTrackDeg": 123,
"payloadIndex": 123,
"pixelPitchUm": 123,
"positionX": 123,
"positionY": 123,
"positionZ": 123,
"radiusDeg": 123,
"sides": 123
}{
"code": "import.tracking.tdm.parse_failed",
"correlationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"details": {},
"error": "Bad Request",
"fieldErrors": {},
"message": "Invalid spacecraft ID format",
"params": {},
"path": "/api/v1/stm/credentials",
"status": 400,
"timestamp": "2025-11-14T10:15:30.123Z"
}{
"error": "invalid_token",
"error_description": "An error occurred while attempting to decode the Jwt"
}{
"code": "import.tracking.tdm.parse_failed",
"correlationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"details": {},
"error": "Bad Request",
"fieldErrors": {},
"message": "Invalid spacecraft ID format",
"params": {},
"path": "/api/v1/stm/credentials",
"status": 400,
"timestamp": "2025-11-14T10:15:30.123Z"
}{
"code": "import.tracking.tdm.parse_failed",
"correlationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"details": {},
"error": "Bad Request",
"fieldErrors": {},
"message": "Invalid spacecraft ID format",
"params": {},
"path": "/api/v1/stm/credentials",
"status": 400,
"timestamp": "2025-11-14T10:15:30.123Z"
}Payloads
Partially update a payload
Updates only the provided scalars of a payload in place (the UUID is never re-minted). The FOV group is an atomic replace: restate fovShape to change any FOV param; a lone FOV param without fovShape is a 400. Returns a uniform 404 for any miss vector. A genuine change to this payload’s offNadirAlongTrackDeg or offNadirCrossTrackDeg field auto-mints a new slew-envelope revision as a same-transaction side effect. A mint failure over frame/attitude interpretability still rolls back the entire PATCH, so the payload’s scalar fields revert to their pre-PATCH persisted values; a mint refused only because the payload’s own aperture is non-isotropic does NOT roll back — the scalar edit still commits, and the rejection surfaces later via the affected AOI opportunities’ own off-nadir disclosure rather than in this response.
PATCH
/
operations
/
spacecraft
/
{spacecraftId}
/
payloads
/
{payloadId}
Partially update a payload
curl --request PATCH \
--url https://api.valar.space/operations/spacecraft/{spacecraftId}/payloads/{payloadId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"boresight": "Z+",
"focalLengthMm": 123,
"fovShape": "CONICAL",
"halfAngleDeg": 30,
"halfHeightDeg": 20,
"halfWidthDeg": 10,
"name": "EO Camera",
"offNadirAlongTrackDeg": 123,
"offNadirCrossTrackDeg": 123,
"pixelPitchUm": 123,
"positionX": 0.1,
"positionY": 0,
"positionZ": -0.2,
"radiusDeg": 30,
"sides": 6
}
'import requests
url = "https://api.valar.space/operations/spacecraft/{spacecraftId}/payloads/{payloadId}"
payload = {
"boresight": "Z+",
"focalLengthMm": 123,
"fovShape": "CONICAL",
"halfAngleDeg": 30,
"halfHeightDeg": 20,
"halfWidthDeg": 10,
"name": "EO Camera",
"offNadirAlongTrackDeg": 123,
"offNadirCrossTrackDeg": 123,
"pixelPitchUm": 123,
"positionX": 0.1,
"positionY": 0,
"positionZ": -0.2,
"radiusDeg": 30,
"sides": 6
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
boresight: 'Z+',
focalLengthMm: 123,
fovShape: 'CONICAL',
halfAngleDeg: 30,
halfHeightDeg: 20,
halfWidthDeg: 10,
name: 'EO Camera',
offNadirAlongTrackDeg: 123,
offNadirCrossTrackDeg: 123,
pixelPitchUm: 123,
positionX: 0.1,
positionY: 0,
positionZ: -0.2,
radiusDeg: 30,
sides: 6
})
};
fetch('https://api.valar.space/operations/spacecraft/{spacecraftId}/payloads/{payloadId}', 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://api.valar.space/operations/spacecraft/{spacecraftId}/payloads/{payloadId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'boresight' => 'Z+',
'focalLengthMm' => 123,
'fovShape' => 'CONICAL',
'halfAngleDeg' => 30,
'halfHeightDeg' => 20,
'halfWidthDeg' => 10,
'name' => 'EO Camera',
'offNadirAlongTrackDeg' => 123,
'offNadirCrossTrackDeg' => 123,
'pixelPitchUm' => 123,
'positionX' => 0.1,
'positionY' => 0,
'positionZ' => -0.2,
'radiusDeg' => 30,
'sides' => 6
]),
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://api.valar.space/operations/spacecraft/{spacecraftId}/payloads/{payloadId}"
payload := strings.NewReader("{\n \"boresight\": \"Z+\",\n \"focalLengthMm\": 123,\n \"fovShape\": \"CONICAL\",\n \"halfAngleDeg\": 30,\n \"halfHeightDeg\": 20,\n \"halfWidthDeg\": 10,\n \"name\": \"EO Camera\",\n \"offNadirAlongTrackDeg\": 123,\n \"offNadirCrossTrackDeg\": 123,\n \"pixelPitchUm\": 123,\n \"positionX\": 0.1,\n \"positionY\": 0,\n \"positionZ\": -0.2,\n \"radiusDeg\": 30,\n \"sides\": 6\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.valar.space/operations/spacecraft/{spacecraftId}/payloads/{payloadId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"boresight\": \"Z+\",\n \"focalLengthMm\": 123,\n \"fovShape\": \"CONICAL\",\n \"halfAngleDeg\": 30,\n \"halfHeightDeg\": 20,\n \"halfWidthDeg\": 10,\n \"name\": \"EO Camera\",\n \"offNadirAlongTrackDeg\": 123,\n \"offNadirCrossTrackDeg\": 123,\n \"pixelPitchUm\": 123,\n \"positionX\": 0.1,\n \"positionY\": 0,\n \"positionZ\": -0.2,\n \"radiusDeg\": 30,\n \"sides\": 6\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.valar.space/operations/spacecraft/{spacecraftId}/payloads/{payloadId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"boresight\": \"Z+\",\n \"focalLengthMm\": 123,\n \"fovShape\": \"CONICAL\",\n \"halfAngleDeg\": 30,\n \"halfHeightDeg\": 20,\n \"halfWidthDeg\": 10,\n \"name\": \"EO Camera\",\n \"offNadirAlongTrackDeg\": 123,\n \"offNadirCrossTrackDeg\": 123,\n \"pixelPitchUm\": 123,\n \"positionX\": 0.1,\n \"positionY\": 0,\n \"positionZ\": -0.2,\n \"radiusDeg\": 30,\n \"sides\": 6\n}"
response = http.request(request)
puts response.read_body{
"boresight": "X+",
"focalLengthMm": 123,
"fovShape": "CONICAL",
"halfAngleDeg": 123,
"halfHeightDeg": 123,
"halfWidthDeg": 123,
"id": "<string>",
"name": "<string>",
"offNadirAlongTrackDeg": 123,
"offNadirCrossTrackDeg": 123,
"payloadIndex": 123,
"pixelPitchUm": 123,
"positionX": 123,
"positionY": 123,
"positionZ": 123,
"radiusDeg": 123,
"sides": 123
}{
"code": "import.tracking.tdm.parse_failed",
"correlationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"details": {},
"error": "Bad Request",
"fieldErrors": {},
"message": "Invalid spacecraft ID format",
"params": {},
"path": "/api/v1/stm/credentials",
"status": 400,
"timestamp": "2025-11-14T10:15:30.123Z"
}{
"error": "invalid_token",
"error_description": "An error occurred while attempting to decode the Jwt"
}{
"code": "import.tracking.tdm.parse_failed",
"correlationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"details": {},
"error": "Bad Request",
"fieldErrors": {},
"message": "Invalid spacecraft ID format",
"params": {},
"path": "/api/v1/stm/credentials",
"status": 400,
"timestamp": "2025-11-14T10:15:30.123Z"
}{
"code": "import.tracking.tdm.parse_failed",
"correlationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"details": {},
"error": "Bad Request",
"fieldErrors": {},
"message": "Invalid spacecraft ID format",
"params": {},
"path": "/api/v1/stm/credentials",
"status": 400,
"timestamp": "2025-11-14T10:15:30.123Z"
}Authorizations
API Key (format: vsp_sk_...)
Body
application/json
Partial payload update — every scalar independently optional; the FOV group is an atomic replace (restate fovShape to change any FOV param).
New body-frame boresight axis (X+, X-, Y+, Y-, Z+, Z-); omit to leave unchanged.
Available options:
X+, X-, Y+, Y-, Z+, Z- Example:
"Z+"
Optical focal length in millimetres (mm) — JsonNullable three-state (DT-8): omit to leave unchanged, send explicit null to clear, send a positive finite number to set. Independent of the FOV group.
New FOV shape. Present ⇒ the whole FOV is replaced (set this shape's params, null all others). Absent ⇒ the FOV is left untouched (a lone FOV param is rejected).
Available options:
CONICAL, RECTANGULAR, ELLIPTICAL, POLYGON Example:
"CONICAL"
Cone half-angle in degrees (CONICAL only). Range (0°, 90°]; 90° accepted.
Required range:
0 < x < 90Example:
30
FOV half-height in degrees (RECTANGULAR / ELLIPTICAL only). Range (0°, 90°) strict.
Required range:
0 < x < 90Example:
20
FOV half-width in degrees (RECTANGULAR / ELLIPTICAL only). Range (0°, 90°) strict.
Required range:
0 < x < 90Example:
10
New payload name; omit to leave unchanged.
Maximum string length:
100Example:
"EO Camera"
Payload off-nadir along-track slew limit in degrees — JsonNullable three-state (DT-8): omit to leave unchanged, send explicit null to clear, send a number in (0°, 90°] to set. Independent of the FOV group and of the optics fields.
Payload off-nadir cross-track slew limit in degrees — JsonNullable three-state (DT-8): omit to leave unchanged, send explicit null to clear, send a number in (0°, 90°] to set. Independent of the FOV group and of the optics fields.
Detector pixel pitch in micrometres (µm) — JsonNullable three-state (DT-8): omit to leave unchanged, send explicit null to clear, send a positive finite number to set. Independent of the FOV group.
New mounting position X in metres (body frame); omit to leave unchanged.
Example:
0.1
New mounting position Y in metres (body frame); omit to leave unchanged.
Example:
0
New mounting position Z in metres (body frame); omit to leave unchanged.
Example:
-0.2
Polygon circumscribed (to-vertices) angular radius in degrees (POLYGON only). Range (0°, 90°) strict.
Required range:
0 < x < 90Example:
30
Number of polygon sides (POLYGON only). 3 ≤ N ≤ 1000.
Required range:
3 <= x <= 1000Example:
6
Response
Payload updated successfully
Available options:
X+, X-, Y+, Y-, Z+, Z- Available options:
CONICAL, RECTANGULAR, ELLIPTICAL, POLYGON Was this page helpful?