Documentation | Files › List Files

Files

files

Methods

Upload File ->

File

post/v5/files

Upload File

Import Files From Existing Blob Storage In Cloud Batch Operation -> { results }

post/v5/files/cloud_imports

Import files from existing blob storage in cloud (batch operation)

List Files -> CursorPage<

File

get/v5/files

List Files

query Parameters

ending_before: string

Optional

filename: string

Optional

Filter files by filename (case-insensitive partial match)

limit: number

Optional

(maximum: 1000, minimum: 1, default: 100)

sort_by: string

Optional

sort_order:

Optional

(default: "asc")

"asc"

"desc"

starting_after: string

Optional

Response fields

has_more: boolean

Whether there are more items left to be fetched.

items: Array<

File

total: number

The total of items that match the query. This is greater than or equal to the number of items returned.

limit: number

Optional

(default: 100)

The maximum number of items to return.

object: "list"

Optional

(default: "list")

Request example

curl https://api.egp.scale.com/v5/files \
    -H "x-api-key: $SGP_API_KEY"

200Example

{
  "has_more": true,
  "items": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by": {
        "id": "id",
        "type": "user",
        "object": "identity"
      },
      "filename": "filename",
      "md5_checksum": "md5_checksum",
      "mime_type": "mime_type",
      "size": 0,
      "duration_seconds": 0,
      "object": "file",
      "tags": {
        "foo": "bar"
      }
    }
  ],
  "total": 0,
  "limit": 0,
  "object": "list"
}