List of Active Short URLs

Description

To get a list of active short URLs, it is necessary to make a GET request to the SHORT URL API endpoint

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

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	Required	Description
Content-Type	Y	application/hal+json; charset=UTF-8

JSON Response

Parameter	Description
page_size	Default page size = 10
page	The number of items to show
total_found	Total number of masked URLs
masked_urls	The details of the individual masked URLs

Sample Response

{
  "page_size":10,
  "page":1,
  "_links":{
    "self":{
      "href":"/short-url/v1/query/url?page=1&page-size=10"
    },
    "first":{
      "href":"/short-url/v1/query/url?page=1&page-size=10"
    },
    "last":{
      "href":"/short-url/v1/query/url?page=1&page-size=10"
    }
  },
  "_embedded":{
    "total_found":1,
    "masked_urls":[
      {
        "id":"pIAr0F",
        "remote_url":"https://www.example.com",
        "name":"Example",
        "description":"Example Short URL",
        "valid_until_date":"2024-06-01 07:31:00",
        "date_created":"2024-05-30 08:46:01",
        "time_last_updated":"2024-05-30 08:47:24",
        "public_masked_url":"https://<api.hostname>/pIAr0F",
        "_links":{
          "self":{
            "href":"/short-url/v1/url/pIAr0F"
          }
        }
      }
    ]
  }
}

If No Short URLs are found

{
  "page_size": 10,
  "page": 1,
  "_links": {
    "self": {
      "href": "/short-url/v1/query/url?page=1&page-size=10"
    },
    "first": {
      "href": "/short-url/v1/query/url?page=1&page-size=10"
    },
    "last": {
      "href": "/short-url/v1/query/url?page=1&page-size=10"
    }
  },
  "_embedded": {
    "total_found": 0,
    "masked_urls": []
  }
}