Skip to navigation
CargoExtra Gateway API Copyroot_admin

Update Root Settings

View as Markdown

Updates root settings through authentication service.

Required body fields from downstream service: website, adminDashboard.

Response fields: message.

Possible errors:

  • 400: Missing One or More Required Parameters - website or adminDashboard missing.
  • 404: Root not found - root configuration document is missing.
  • 400: Missing One or More Required Parameters - required body/query fields were not supplied.
  • 401: Unauthorized - token is missing, expired, invalid, or the account/token pair was not found.
  • 403: Access denied - gateway traffic guard/rate policy blocked the request.
  • 429: Too many requests - gateway rate limit exceeded.
  • 500: Unexpected Error - unhandled gateway or downstream service failure.

Request

This endpoint expects an object.
websitestringRequiredformat: "uri"
adminDashboardstringRequiredformat: "uri"

Response

OK
key_0integer
key_1string
key_2double
key_3string
key_4boolean

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error