RAIDR/API Reference/Deployments

Update deployment

patchhttp://127.0.0.1:8787/api/v1/deployments/{id}

Updates name, center, or region. To remove a region, send clear_region: true, since a null region is otherwise indistinguishable from leaving it unchanged.

Path parameters

idstring <uuid>Required

Deployment ID.

Request

application/json

This endpoint expects an object.

namestringRequired
centerLatLonOptional
regionobjectOptional

Optional rectangular region of interest.

clear_regionbooleanOptional

Remove the region of interest.

Response

200 · application/json

Updated deployment. Returns a Deployment object.

idstring <uuid>Required
namestringRequired
centerLatLonOptional
regionobjectOptional

Optional rectangular region of interest.

created_atstring <date-time>Optional
updated_atstring <date-time>Optional

Errors

400
Problem

Malformed request.

404
Problem

Resource not found.