storage_hosts_post {civis}R Documentation

Create a new storage host

Description

Create a new storage host

Usage

storage_hosts_post(provider, bucket, name, s3_options = NULL)

Arguments

provider

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

bucket

string required. The bucket for this storage host.

name

string required. The human readable name for the 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")


[Package civis version 3.0.0 Index]