Skip to main content
PATCH
Error

Path Parameters

​
spacecraftId
string
required

Parent spacecraft id

​
payloadId
string
required

Payload id

Body

application/json

Partial payload update — every scalar independently optional; the FOV group is an atomic replace (restate fovShape to change any FOV param).

​
boresight
enum<string>

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+"

​
focalLengthMm
number<double> | null

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.

​
fovShape
enum<string>

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"

​
halfAngleDeg
number<double>

Cone half-angle in degrees (CONICAL only). Range (0°, 90°]; 90° accepted.

Required range: 0 < x < 90
Example:

30

​
halfHeightDeg
number<double>

FOV half-height in degrees (RECTANGULAR / ELLIPTICAL only). Range (0°, 90°) strict.

Required range: 0 < x < 90
Example:

20

​
halfWidthDeg
number<double>

FOV half-width in degrees (RECTANGULAR / ELLIPTICAL only). Range (0°, 90°) strict.

Required range: 0 < x < 90
Example:

10

​
name
string

New payload name; omit to leave unchanged.

Maximum string length: 100
Example:

"EO Camera"

​
offNadirAlongTrackDeg
number<double> | null

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.

​
offNadirCrossTrackDeg
number<double> | null

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.

​
pixelPitchUm
number<double> | null

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.

​
positionX
number<double>

New mounting position X in metres (body frame); omit to leave unchanged.

Example:

0.1

​
positionY
number<double>

New mounting position Y in metres (body frame); omit to leave unchanged.

Example:

0

​
positionZ
number<double>

New mounting position Z in metres (body frame); omit to leave unchanged.

Example:

-0.2

​
radiusDeg
number<double>

Polygon circumscribed (to-vertices) angular radius in degrees (POLYGON only). Range (0°, 90°) strict.

Required range: 0 < x < 90
Example:

30

​
sides
integer<int32>

Number of polygon sides (POLYGON only). 3 ≤ N ≤ 1000.

Required range: 3 <= x <= 1000
Example:

6

Response

Payload updated successfully

​
boresight
enum<string>
Available options:
X+,
X-,
Y+,
Y-,
Z+,
Z-
​
focalLengthMm
number<double>
​
fovShape
enum<string>
Available options:
CONICAL,
RECTANGULAR,
ELLIPTICAL,
POLYGON
​
halfAngleDeg
number<double>
​
halfHeightDeg
number<double>
​
halfWidthDeg
number<double>
​
id
string
​
name
string
​
offNadirAlongTrackDeg
number<double>
​
offNadirCrossTrackDeg
number<double>
​
payloadIndex
integer<int32>
​
pixelPitchUm
number<double>
​
positionX
number<double>
​
positionY
number<double>
​
positionZ
number<double>
​
radiusDeg
number<double>
​
sides
integer<int32>