Update a file

client.Files.Update(ctx, fileID, params) (*SGPFile, error)

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.

ParametersExpand Collapse

fileID string

params FileUpdateParams

Tags param.Field[map[string, any]]Optional

Body param

XProjectID param.Field[string]Optional

Header param

ReturnsExpand Collapse

type SGPFile struct{…}

ID string

The unique identifier of the entity.

CreatedAt Time

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

formatdate-time

CreatedBy Identity

The identity that created the entity.

ID string

Type IdentityType

One of the following:

const IdentityTypeUser IdentityType = "user"

const IdentityTypeServiceAccount IdentityType = "service_account"

Object IdentityObjectOptional

Filename string

Md5Checksum string

MimeType string

Size int64

DurationSeconds int64Optional

Object SGPFileObjectOptional

Tags map[string, any]Optional

Update a file

package main

import (
  "context"
  "fmt"

  "github.com/scaleapi/sgp-dev-go"
  "github.com/scaleapi/sgp-dev-go/option"
)

func main() {
  client := sgpdev.NewClient(
    option.WithAPIKey("My API Key"),
    option.WithAccountID("My Account ID"),
  )
  sgpFile, err := client.Files.Update(
    context.TODO(),
    "file_id",
    sgpdev.FileUpdateParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", sgpFile.ID)
}

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