Returns the specified S3 location

GET 
/v1/users/assets/locations/s3/:uid

Returns the specified S3 location

Request

Path Parameters

uid stringrequired

Specify the S3 location uid

Responses

200

(empty)

application/json

Schema

Schema

metadata

object

ObjectMeta input entity for object creation

annotations

object

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

property name*string

labels

object

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

property name*string

namestring

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

spec

object

S3 location specification

config

object

required

S3 storage config object

bucketNamestringrequired

S3 storage bucket name

caCertstring

CA Certificate

credentials

object

required

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]

Example (from schema)

{
  "metadata": {
    "annotations": {},
    "labels": {},
    "name": "string"
  },
  "spec": {
    "config": {
      "bucketName": "string",
      "caCert": "string",
      "credentials": {
        "accessKey": "string",
        "credentialType": "secret",
        "partition": "aws",
        "policyARNs": [
          "string"
        ],
        "secretKey": "string",
        "sts": {
          "arn": "string",
          "externalId": "string"
        }
      },
      "region": "string",
      "s3ForcePathStyle": true,
      "s3Url": "string",
      "useRestic": true
    },
    "isDefault": true,
    "type": "string"
  }
}

Loading...