Check path

This endpoint checks if a path will work or not. This includes checking to make sure that no other page has already used it, as well as checking that it doesn’t match any special, reserved system paths.

Request

Path Parameters
Path Parameters	Value
`path`	The path to check. This parameter can include the `/` character, as in `/v1/checkpath/totally/open/path`.

Examples

Example Request

GET /v1/checkpath/pathtotest HTTP/1.1
Host: api.thefifthworld.com

Example Request

GET /v1/checkpath/path/to/test HTTP/1.1
Host: api.thefifthworld.com

Response

This endpoint responds with a 200 HTTP status and an object describing the result of your check.

JSON Object
Property	Value Type	Value
`ok`	`boolean`	If `true`, the path should work. If `false`, the path won’t work.
`error`	`string`	You will only receive this property when `ok` equals `false`. This provides a textual description of why the path doesn’t work, suitably for displaying back to the user.

Example

Example Response

{
  "ok": true
}

Example Response

{
  "ok": false,
  "error": "A page with the path <code>/animism</code> already exists."
}