List Destinations

4 min

List Destinations

You can List all of the Destinations currently set up on your account by making making a HTTP GET request to the /destinations endpoint.

Parameters

The following querystring (HTTP GET) parameters allow you to refine the results returned by the Destinations List API.

Parameter	Required	Description
api_key	required	The API key for your account.
search_term	optional	Limits the returned Destinations to just those containing the search_term in their name.
page	optional	Set the page number of Destinations to return, defaults to page=1 . 10 Destinations are returned per page.
sort_by	optional	The sort order to apply to the results. Valid values are type (to sort by Destination type) or name (to sort by Destination name).
sort_direction	optional	The sort direction to return results. Valid values are descending or ascending (the default). Use in conjunction with the sort_by parameter.

Example

GET /destinations

In the example below we List page 1 of all the Destinations on your account:

https://api.bigboxapi.com/destinations?api_key=demo

BigBox API responds with the following JSON showing page 1 of all the Destinations on your BigBox API account:

{
  "request_info": {
    "success": true
  },
  "usage": {
    "used": 1,
    "limit": 50,
    "available": 49
  },
  "destinations": [
    {
      "id": "ABCDEFG",
      "name": "My First S3 Destination",
      "type": "s3",
      "enabled": true,
      "used_by": 0,
      "s3_bucket_name": "s3_bucket_name",
      "s3_path_prefix": "my_path_prefix"
    }
  ]
}

Next Steps Update Destination Delete Destination