Objects

post

List all Objects in a Bucket

List details about all objects within a bucket based on the bucket name. The results can be paginated.

pagenumber

Jump to a specific page of results.

Example
1
limitnumber

Limit the number of items on a result page.

Example
10
startDatestring

The starting date for filtering buckets based on the date they were created. This attribute accepts ISO 8601 dates in YYYY-MM-DD format.

Format
date
Example
"2024-10-01"
endDatestring

The ending date for filtering buckets based on the date they were created. This attribute accepts ISO 8601 dates in YYYY-MM-DD format.

Format
date
Example
"2024-10-15"

Responses

Request examples

{
  "page": 1,
  "limit": 10,
  "startDate": "2024-10-01",
  "endDate": "2024-10-15"
}

Response examples

Successful response

{
  "success": true,
  "message": "string",
  "data": {
    "docs": [
      {
        "org": "org-a01f25f9ae6340bd970144141d331234",
        "project": "prj-c3b08d852de54d64a4a15c39ad451234",
        "createdBy": "usr-6b5f02d47e6d4682a62262d6174c1234",
        "objectKey": "image.png",
        "bucket": "bkt-b1627187f6904b9e989304fb2af91234",
        "location": "https://cdn.dev.usenebula.io/bucket-name/image.png",
        "fileFormat": "image/png",
        "fileSize": 14146,
        "createdAt": "2024-10-11T00:16:38.112Z",
        "updatedAt": "2024-10-12T00:16:38.112Z",
        "objectId": "obj-c59e099381424c95a8f075b109a61234"
      }
    ],
    "pagination": {
      "totalDocs": 15,
      "limit": 20,
      "page": 1,
      "totalPages": 5,
      "pagingCounter": 11,
      "prevPage": 1,
      "nextPage": 3
    }
  }
}
post

Upload Object

Upload an object into a bucket in the project that the API key belongs to. Files are uploaded using FormData.

objectKeystring

required

The object key, or filename of the object in your bucket.

Example
"uploaded_image.png"
objectfile

required

The local path, filename, and file extension of the object you want to upload.

Example
"D:/data/local_image.png"

Responses

Response examples

Successful response

{
  "success": true,
  "message": "Object successfully uploaded.",
  "data": {
    "org": "org-a01f25f9ae6340bd970144141d331234",
    "project": "prj-c3b08d852de54d64a4a15c39ad451234",
    "createdBy": "usr-6b5f02d47e6d4682a62262d6174c1234",
    "objectKey": "image.png",
    "bucket": "bkt-b1627187f6904b9e989304fb2af91234",
    "location": "https://cdn.dev.usenebula.io/bucket-name/image.png",
    "fileFormat": "image/png",
    "fileSize": 14146,
    "createdAt": "2024-10-11T00:16:38.112Z",
    "updatedAt": "2024-10-12T00:16:38.112Z",
    "objectId": "obj-c59e099381424c95a8f075b109a61234"
  }
}
get

Get Object

Retrieve details about an object based on the object's name and the bucket it's located in.

bucketNamestring

required

The name of the bucket where the object is.

objectKeystring

required

The object key, or filename of the object you want details about.

Responses

Response examples

Successful response

{
  "success": true,
  "message": "Object successfully retrieved.",
  "data": {
    "org": "org-a01f25f9ae6340bd970144141d331234",
    "project": "prj-c3b08d852de54d64a4a15c39ad451234",
    "createdBy": "usr-6b5f02d47e6d4682a62262d6174c1234",
    "objectKey": "image.png",
    "bucket": "bkt-b1627187f6904b9e989304fb2af91234",
    "location": "https://cdn.dev.usenebula.io/bucket-name/image.png",
    "fileFormat": "image/png",
    "fileSize": 14146,
    "createdAt": "2024-10-11T00:16:38.112Z",
    "updatedAt": "2024-10-12T00:16:38.112Z",
    "objectId": "obj-c59e099381424c95a8f075b109a61234"
  }
}
delete

Delete Object

Permanently removes an object from a bucket. This action cannot be reverted.

bucketNamestring

required

The name of the bucket where the object is.

objectKeystring

required

The object key, or filename of the object you want to delete.

Responses

Response examples

No response

{
  "success": true,
  "message": "Object successfully deleted.",
  "data": "string"
}

Was this page helpful?