SAsamsara
Beta APIs

[beta] List Functions storage files.

List files in Functions storage for the organization. Returns file metadata and optionally includes presigned download or upload URLs.

<b>Rate limit:</b> 100 requests/min (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).

To use this endpoint, select Read Functions Storage under the Functions category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.

get/functions-storage/ls

Request

  • Base URL
    https://api.samsara.com
  • Auth
    HTTP bearer

Query parameters

afterstring

If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.

limitinteger

The maximum number of files to return per page.

includeDownloadUrlsboolean

If true, include presigned download URLs for each file.

includeUploadUrlsboolean

If true, include presigned upload URLs for each file. Requires write permission.

prefixstring

Only list files and immediate subfolders under this path prefix, for example logs/.

groupByFolderboolean

When true, roll immediate subfolders up into the folders field and return only files directly under the prefix in data.

Response

OK response.

Example response

{
  "data": [
    {
      "modifiedAtTime": "2024-01-01T12:00:00Z",
      "name": "my-script.js",
      "sizeBytes": 1024,
      "urls": [
        {
          "expiresAtTime": "2024-01-01T13:00:00Z",
          "url": "https://s3.amazonaws.com/bucket/key?signature=abc123",
          "urlType": "download"
        }
      ]
    }
  ],
  "folders": [
    {
      "name": "logs/archive/"
    }
  ],
  "pagination": {
    "endCursor": "MjkY",
    "hasNextPage": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.