Request S3 storage configuration

v1.0.0

🚀 Since v4.3.0

Description:

Retrieve S3 configuration.

Precondition:

Right 🔓 read global config and role 👤 Config Manager of the Provider Customer required.

Postcondition:

S3 configuration is returned.

Further Information:

None.

Virtual hosted style access

Example: https://bucket-name.s3.region.amazonaws.com/key-name

Input

{
  "type": "object",
  "properties": {
    "X-Sds-Auth-Token": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "S3 configuration",
  "required": [
    "accessKeyDefined",
    "bucketUrl",
    "secretKeyDefined"
  ],
  "properties": {
    "accessKeyDefined": {
      "type": "boolean",
      "description": "Determines whether Access Key ID is defined"
    },
    "bucketName": {
      "type": "string",
      "description": "&#128679; Deprecated since v4.24.0\n\nS3 bucket name\n\nuse `bucketUrl` instead"
    },
    "bucketUrl": {
      "type": "string",
      "description": "S3 object storage bucket URL"
    },
    "endpointUrl": {
      "type": "string",
      "description": "&#128679; Deprecated since v4.24.0\n\nS3 object storage endpoint URL\n\nuse `bucketUrl` instead"
    },
    "region": {
      "type": "string",
      "description": "S3 region"
    },
    "secretKeyDefined": {
      "type": "boolean",
      "description": "Determines whether Access Secret Key is defined"
    }
  }
}