Get metadata

GET 
/

Returns the deployed API version and the list of public routes available on it. Useful as a sanity check when you can reach the server but want to confirm what's wired up.

Request

Responses

200

application/json

Schema

Schema

version stringrequired

routes

object[]

required

Array [

method stringrequired

path stringrequired

]

Example (from schema)

{
  "version": "string",
  "routes": [
    {
      "method": "string",
      "path": "string"
    }
  ]
}

429

Too Many Requests

application/json

Schema

Schema

message stringrequired
statusCode numberrequired
error string

Available only when the message includes additional error details.

Example (from schema)

{
  "message": "string",
  "statusCode": 0,
  "error": "string"
}

500

Internal Server Error

application/json

Schema

Schema

message stringrequired
statusCode numberrequired
error string

Available only when the message includes additional error details.

Example (from schema)

{
  "message": "string",
  "statusCode": 0,
  "error": "string"
}

Loading...