Skip to main content
GET
/
buckets
cURL
curl --request GET \
  --url https://api.nightly.sh/v1/buckets \
  --header 'Authorization: Bearer <token>'
{
  "has_more": true,
  "next_uri": "next-uri-here",
  "data": [
    {
      "id": "nly_test_buc_1amaj5125as",
      "name": "Acme Corporation Bucket",
      "host": "1amaj5125as.sftp.nightly.sh",
      "active": true,
      "created_at": 692233200
    },
    {
      "id": "nly_test_buc_8gkde9034zx",
      "name": "Example Organization Bucket",
      "host": "8gkde9034zx.sftp.nightly.sh",
      "active": true,
      "created_at": 692233200
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
limit
integer

The maximum number of results to return

​
after
string

The last ID on the page you're currently on when you want to fetch the next page.

Response

Bucket response

​
data
object[]

Array of buckets

Example:
[
  {
    "id": "nly_test_buc_1amaj5125as",
    "name": "Acme Corporation Bucket",
    "host": "1amaj5125as.sftp.nightly.sh",
    "active": true,
    "created_at": 692233200
  },
  {
    "id": "nly_test_buc_8gkde9034zx",
    "name": "Example Organization Bucket",
    "host": "8gkde9034zx.sftp.nightly.sh",
    "active": true,
    "created_at": 692233200
  }
]
​
has_more
boolean

Indicates if there are more buckets to fetch

​
next_uri
string

The URI to fetch the next page of results, if any.

Example:

"next-uri-here"