Skip to main content

Create a MinIO location

POST 
/v1/users/assets/locations/minio

Create a MinIO location

Request​

Body

    metadata object

    ObjectMeta input entity for object creation

    annotations object

    Annotations are system generated key value metadata for the resource. As an input certain annotations like description can be set

    property name*string
    labels object

    Labels are key value data to organize and categorize resources. Providing spectro__tag as value for a label is considered as a kubernetes compliant tag

    property name*string
    namestring

    Name of the resource

    spec object

    S3 location specification

    config objectrequired

    S3 storage config object

    bucketNamestringrequired

    S3 storage bucket name

    caCertstring

    CA Certificate

    credentials objectrequired

    AWS cloud account which includes access key and secret key in case of 'secret' credentials type. It includes policyARNS, ARN and externalId in case of sts. Partition is a group of AWS Region and Service objects

    accessKeystring

    AWS account access key

    credentialTypestring

    Possible values: [secret, sts]

    Default value: secret

    Allowed Values [secret, sts]. STS type will be used for role assumption for sts type, accessKey/secretKey contains the source account, Arn is the target account.

    partitionstring

    Possible values: [aws, aws-us-gov]

    Default value: aws

    AWS accounts are scoped to a single partition. Allowed values [aws, aws-us-gov], Default values

    policyARNsstring[]

    List of policy ARNs required in case of credentialType sts.

    secretKeystring

    AWS account secret key

    sts object

    AWS STS credentials in case of credentialType sts, will be empty in case of credential type secret

    arnstring

    Arn for the aws sts credentials in cloud account

    externalIdstring

    ExternalId for the aws sts credentials in cloud account

    regionstringrequired

    AWS region name

    s3ForcePathStyleboolean

    Default value: true

    s3Urlstring

    Custom hosted S3 URL

    useResticboolean

    Default value: true

    Set to 'true', to use Restic plugin for the backup

    isDefaultboolean

    Set to 'true', if location has to be set as default

    typestring

    S3 location type [s3/minio]

Responses​

Created successfully

Response Headers
  • AuditUid string

    Audit uid for the request

Schema
    uidstringrequired
Loading...