storage_hosts_patch {civis}

Update some attributes of this storage host

Description

Update some attributes of this storage host

Usage

storage_hosts_patch(
  id,
  name = NULL,
  provider = NULL,
  bucket = NULL,
  s3_options = NULL
)

Arguments

id

integer required. The ID of the storage host.

name

string optional. The human readable name for the storage host.

provider

string optional. The storage provider.One of: s3.

bucket

string optional. The bucket for this storage host.

s3_options

list optional. A list containing the following elements:

• region string, The region for this storage host (ex. "us-east-1")

Value

A list containing the following elements:

id

integer, The ID of the storage host.

owner

list, A list containing the following elements:

• id integer, The ID of this user.

• name string, This user's name.

• username string, This user's username.

• initials string, This user's initials.

• online boolean, Whether this user is online.

name

string, The human readable name for the storage host.

provider

string, The storage provider.One of: s3.

bucket

string, The bucket for this storage host.

s3Options

list, A list containing the following elements:

• region string, The region for this storage host (ex. "us-east-1")