Skip to navigation
ProxyBackends

Update a CSMS backend

Admin only (role=admin). Partially updates a CSMS backend: only fields present in the body change. Send expected_revision to refuse the update if the row changed since you read it.

Authentication

AuthorizationBearer

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

Path parameters

backend_idstringRequiredformat: "uuid"

Request

This endpoint expects an object.
namestring or nullOptional1-255 characters
urlstring or nullOptional1-255 characters
enabledboolean or nullOptional
priorityinteger or nullOptional
authmap from strings to any or nullOptional
expected_revisioninteger or nullOptional>=1

Refuse the update (409) unless the row is still at this revision.

Response

Successful Response
idstringformat: "uuid"
namestring
urlstring
created_atdatetime
updated_atdatetime
enabledbooleanOptionalDefaults to true
priorityintegerOptionalDefaults to 100
revisionintegerOptionalDefaults to 1
Bumped on every update.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
502
Bad Gateway Error
504
Gateway Timeout Error