urlsparkle (0.1.0)

Download OpenAPI specification:

License: MIT License

health

Health check

Health check endpoint

Responses

Response samples

Content type
application/health+json
{
  • "status": "pass"
}

Readiness check

Readiness check endpoint

Responses

Response samples

Content type
application/health+json
{
  • "status": "pass",
  • "checks": {
    }
}

Redirect to original URL

Redirects to the original URL based on the provided shortcode.

path Parameters
shortcode
required
string (Shortcode)

Responses

Response samples

Content type
application/json
null

Stats

path Parameters
shortcode
required
string (Shortcode)

Responses

Response samples

Content type
application/json
{
  • "created": "2017-05-10T20:45:00.000Z",
  • "lastRedirect": "2018-05-16T10:16:24.666Z",
  • "redirect_count": 6
}

shorten

Shorten a URL

Shorten a URL to a 6-character or custom shortcode

Request Body schema: application/json
required
url
required
string (Url)
Shortcode (string) or Shortcode (null) (Shortcode)

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "shortcode": "string",
  • "update_id": "bfaba883-030c-4346-ae6c-c59b9a3dc36d"
}

update

Update a URL

Update the URL associated with a given update ID.

path Parameters
update_id
required
string (Update Id)
Request Body schema: application/json
required
url
required
string (Url)

Responses

Request samples

Content type
application/json

Response samples

Content type
application/json
{
  • "shortcode": "abn123"
}