GET
curl --request GET \
  --url https://cloud.local.wirtual.dev/api/v2/
{
  "detail": "<string>",
  "message": "<string>",
  "validations": [
    {
      "detail": "<string>",
      "field": "<string>"
    }
  ]
}

Response

200 - application/json
OK
​
detail
string

Detail is a debug message that provides further insight into why the action failed. This information can be technical and a regular golang err.Error() text.

  • "database: too many open connections"
  • "stat: too many open files"
​
message
string

Message is an actionable message that depicts actions the request took. These messages should be fully formed sentences with proper punctuation. Examples:

  • "A user has been created."
  • "Failed to create a user."
​
validations
object[]

Validations are form field-specific friendly error messages. They will be shown on a form field in the UI. These can also be used to add additional context if there is a set of errors in the primary 'Message'.