API Documentation

This documentation will guide you through how to use this API.

General

Here is a general overview of this API.

The API will return a value status with the key of success (200) or fail (400) along with a message which explains why the request failed.

Example URL: https://r0.al/api?url=https://rmly.dev&name=testing123

Result:

{
  "status": "success",
  "name": "testing123",
  "url": "https://r0.al/testing123"
}

Notes

A value status with the key of fail and status a code of 400 will be returned if:

A random string will be generated if the name parameter is not passed, or if the name already exists.

This API is limited to 10 requests in a interval of 10 minutes per IP address.

Go back