{"type":"array","items":{"description":"api_object_relationship_v3","type":"object","properties":{"id":{"description":"Unique identifier of the replication relationship","type":"string"},"direction":{"type":"string","enum":["COPY_TO_OBJECT","COPY_FROM_OBJECT"],"description":"The object relationship can either copy data to or from the object store:\n * `COPY_FROM_OBJECT` - COPY_FROM_OBJECT,\n * `COPY_TO_OBJECT` - COPY_TO_OBJECT"},"local_directory_id":{"description":"File ID of the qumulo directory","type":"string"},"object_store_address":{"description":"S3-compatible server address","type":"string"},"port":{"description":"HTTPS port to use when communicating with the object store","type":"number"},"ca_certificate":{"description":"Public certificate of the certificate authority to trust for connections to the object store, in PEM format. If empty, the built-in trusted public CAs are used.","type":"string"},"bucket":{"description":"Bucket in the object store to use","type":"string"},"bucket_style":{"type":"string","enum":["BUCKET_STYLE_PATH","BUCKET_STYLE_VIRTUAL_HOSTED"],"description":"Addressing style for requests to the bucket. BUCKET_STYLE_PATH indicates path-style addressing while BUCKET_STYLE_VIRTUAL_HOSTED indicates virtual hosted-style.:\n * `BUCKET_STYLE_PATH` - BUCKET_STYLE_PATH,\n * `BUCKET_STYLE_VIRTUAL_HOSTED` - BUCKET_STYLE_VIRTUAL_HOSTED"},"object_folder":{"description":"Folder in the object store bucket to use","type":"string"},"region":{"description":"Region the bucket is located in","type":"string"},"access_key_id":{"description":"Access key ID to use when communicating with the object store","type":"string"}}}}
POST
Create a new object replication relationship. Replication will automatically start after the relationship is created.
Parameters
This resource has no parameters.
Request
Schema
{"description":"api_object_create_request_v3","type":"object","properties":{"direction":{"type":"string","enum":["COPY_TO_OBJECT","COPY_FROM_OBJECT"],"description":"Whether data is to be copied to, or from, the object store:\n * `COPY_FROM_OBJECT` - COPY_FROM_OBJECT,\n * `COPY_TO_OBJECT` - COPY_TO_OBJECT"},"local_directory_id":{"description":"File ID of the qumulo directory if local_directory_path is not provided","type":"string"},"local_directory_path":{"description":"Path of the qumulo directory if local_directory_id is not provided","type":"string"},"object_store_address":{"description":"S3-compatible server address. For Amazon S3, use s3.<region>.amazonaws.com (e.g., s3.us-west-2.amazonaws.com).","type":"string"},"port":{"description":"HTTPS port to use when communicating with the object store (default: 443)","type":"number"},"ca_certificate":{"description":"Public certificate of the certificate authority to trust for connections to the object store, in PEM format (defaults to built-in trusted public CAs)","type":"string"},"bucket":{"description":"Bucket in the object store to use for this relationship","type":"string"},"bucket_style":{"type":"string","enum":["BUCKET_STYLE_PATH","BUCKET_STYLE_VIRTUAL_HOSTED"],"description":"Addressing style for requests to the bucket. Set to BUCKET_STYLE_PATH for path-style addressing or BUCKET_STYLE_VIRTUAL_HOSTED for virtual hosted-style (the default). For Amazon S3, virtual hosted-style is recommended as path-style is deprecated. Bucket names containing dots ('.') or characters that are not valid in domain names may require path-style. The object_store_address should not include the bucket name, regardless of addressing style.:\n * `BUCKET_STYLE_PATH` - BUCKET_STYLE_PATH,\n * `BUCKET_STYLE_VIRTUAL_HOSTED` - BUCKET_STYLE_VIRTUAL_HOSTED"},"object_folder":{"description":"Folder to use in the object store bucket. A slash separator is automatically used to specify a 'folder' in a bucket. For example, a folder of 'example' and a file path (relative to the directory_path) of 'dir/file' will result in key 'example/dir/file'. Use empty value '' or '/' to replicate with the root of the bucket.","type":"string"},"region":{"description":"Region the bucket is located in","type":"string"},"access_key_id":{"description":"Access key ID to use when communicating with the object store","type":"string"},"secret_access_key":{"description":"Secret access key to use when communicating with the object store","type":"string","format":"password"}}}
Response
Codes
Code
Description
200
Return value on success
Schema
{"description":"api_object_relationship_v3","type":"object","properties":{"id":{"description":"Unique identifier of the replication relationship","type":"string"},"direction":{"type":"string","enum":["COPY_TO_OBJECT","COPY_FROM_OBJECT"],"description":"The object relationship can either copy data to or from the object store:\n * `COPY_FROM_OBJECT` - COPY_FROM_OBJECT,\n * `COPY_TO_OBJECT` - COPY_TO_OBJECT"},"local_directory_id":{"description":"File ID of the qumulo directory","type":"string"},"object_store_address":{"description":"S3-compatible server address","type":"string"},"port":{"description":"HTTPS port to use when communicating with the object store","type":"number"},"ca_certificate":{"description":"Public certificate of the certificate authority to trust for connections to the object store, in PEM format. If empty, the built-in trusted public CAs are used.","type":"string"},"bucket":{"description":"Bucket in the object store to use","type":"string"},"bucket_style":{"type":"string","enum":["BUCKET_STYLE_PATH","BUCKET_STYLE_VIRTUAL_HOSTED"],"description":"Addressing style for requests to the bucket. BUCKET_STYLE_PATH indicates path-style addressing while BUCKET_STYLE_VIRTUAL_HOSTED indicates virtual hosted-style.:\n * `BUCKET_STYLE_PATH` - BUCKET_STYLE_PATH,\n * `BUCKET_STYLE_VIRTUAL_HOSTED` - BUCKET_STYLE_VIRTUAL_HOSTED"},"object_folder":{"description":"Folder in the object store bucket to use","type":"string"},"region":{"description":"Region the bucket is located in","type":"string"},"access_key_id":{"description":"Access key ID to use when communicating with the object store","type":"string"}}}
