Retrieve Short URL Details

Description

To retrieve details of a short URL, it is necessary to make a GET request to the SHORT URL API endpoint with the "masked_url_id"

Production Endpoint URL: https://api.cpaas.symphony.rakuten.net/short-url/v1/url/$masked_url_id

Methods: GET

HTTP Headers

Parameter	Required	Value
Authentication	Y	Type: Bearer Token: JWT Token
Accept	Y	application/json
Content-Type	Y	application/json; charset=UTF-8

Response:

If successful, the API call will return an HTTP 200 OK with a JSON document as a response. Please see section "Error Codes" for a description of the failure responses.

Parameter	Description
id	masked_url_id
remote_url	Destination URL used for masking
name	Name of the Short URL
description	Description of Short URL
valid_until_date	Valid until date in yyyy-MM-dd HH:mm:ss
date_created	Date created in yyyy-MM-dd HH:mm:ss
time_last_updated	Short URL last updated in yyyy-MM-dd HH:mm:ss
public_masked_url	https://<api.hostname>/<masked_url_id>

Sample Response

{
  "id": "masked_url_id",
  "remote_url": "...Destination URL...",
  "name": "...Name of Short URL...",
  "description": "...Description of Short URL...",
  "valid_until_date": "...Valid until date in yyyy-MM-dd HH:mm:ss...",
  "date_created": "...Date created in yyyy-MM-dd HH:mm:ss...",
  "time_last_updated": "...Short URL last updated in yyyy-MM-dd HH:mm:ss...",
  "public_masked_url": "https://<api.hostname>/<masked_url_id>"
}

Retrieve Short URL Details

Description​

Description