Update a file

PATCH/v5/files/{file_id}

Update a file’s mutable metadata by id.

Only the file’s tags can be modified; filename, content, size, and other attributes are immutable through this endpoint. The supplied tags replace the file’s existing tags. Returns the updated file metadata.

Path ParametersExpand Collapse

file_id: string

Header ParametersExpand Collapse

"x-project-id": optional string

Body ParametersJSONExpand Collapse

tags: optional map[unknown]

ReturnsExpand Collapse

SGPFile object { id, created_at, created_by, 7 more }

id: string

The unique identifier of the entity.

created_at: string

The date and time when the entity was created in ISO format.

formatdate-time

created_by: Identity { id, type, object }

The identity that created the entity.

id: string

type: "user" or "service_account"

One of the following:

"user"

"service_account"

object: optional "identity"

filename: string

md5_checksum: string

mime_type: string

size: number

duration_seconds: optional number

object: optional "file"

tags: optional map[unknown]

Update a file

curl https://api.egp.scale.com/v5/files/$FILE_ID \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "x-api-key: $SGP_API_KEY" \
    -d '{}'

{
  "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"
  }
}

Returns Examples

{
  "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"
  }
}