Skip to main content
PATCH
/
buckets
/
{id}
cURL
curl --request PATCH \
  --url https://api.nightly.sh/v1/buckets/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "active": true
}
'
{
  "id": "nly_test_buc_1amaj5125as",
  "name": "Acme Corporation Bucket",
  "host": "1amaj5125as.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.

Path Parameters

​
id
string
required

ID of bucket to update

Body

application/json

Bucket data to update

​
name
string

The human-readable name for the bucket. If not provided, the name will not be updated.

​
active
boolean

Whether or not the bucket is active and accepting connections/files. If not provided, the active status will not be updated.

Response

Bucket updated

​
id
string
required

Unique identifier for the bucket.

​
host
string
required

The host for the bucket. This can be provided to your customers for SFTP connectivity.

​
name
string
required

The human-readable name for the bucket.

​
active
boolean
required

Whether or not the bucket is active and accepting connections/files.

​
created_at
integer
required

Unix Timestamp of when the bucket was created.