Default

Get S3 buckets

get
Authorizations
Query parameters
s3_bucket_idsstringOptional
s3_bucket_namesstringOptional
aws_account_idsstringOptional
data_elementsstringOptional
data_catgoriesstringOptional
last_accessedstringOptional
last_modifiedstringOptional
created_atstringOptional
limitintegerOptional
offsetintegerOptional
Responses
200
List of S3 buckets
application/json
get
GET /v1/aws/s3/buckets HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*
200

List of S3 buckets

{
  "data": [
    {
      "id": 1,
      "aws_account_id": 1,
      "aws_account_identifier": "text",
      "bucket_name": "text",
      "region": "text",
      "versioning": true,
      "server_side_encryption": true,
      "data_elements": [
        "text"
      ],
      "personas": [
        "text"
      ]
    }
  ],
  "total_count": 1
}

Get S3 bucket by ID

get
Authorizations
Path parameters
idintegerRequired
Responses
200
S3 bucket object
application/json
get
GET /v1/aws/s3/buckets/{id} HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*
200

S3 bucket object

{
  "id": 1,
  "aws_account_id": 1,
  "aws_account_identifier": "text",
  "bucket_name": "text",
  "region": "text",
  "versioning": true,
  "server_side_encryption": true,
  "data_elements": [
    "text"
  ],
  "personas": [
    "text"
  ]
}

Get S3 objects

get
Authorizations
Query parameters
s3_object_idsstringOptional
s3_object_keysstringOptional
s3_bucket_idsstringOptional
s3_bucket_namesstringOptional
aws_account_idsstringOptional
data_elementsstringOptional
data_categoriesstringOptional
data_subjectstringOptional
last_accessedstringOptional
last_modifiedstringOptional
created_atstringOptional
limitintegerOptional
offsetintegerOptional
Responses
200
List of S3 objects
application/json
get
GET /v1/aws/s3/objects HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*
200

List of S3 objects

{
  "data": [
    {
      "id": 1,
      "key": "text",
      "size": 1,
      "mime_type": "text",
      "file_type": "text",
      "storage_class": "text",
      "last_modified": "2025-06-25T04:56:26.028Z",
      "aws_account_id": 1,
      "s3_bucket_id": 1,
      "s3_bucket_name": "text",
      "data_elements": [
        "text"
      ],
      "personas": [
        "text"
      ]
    }
  ]
}

Get S3 object by ID

get
Authorizations
Path parameters
idintegerRequired
Responses
200
S3 object
application/json
get
GET /v1/aws/s3/objects/{id} HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*
200

S3 object

{
  "id": 1,
  "key": "text",
  "size": 1,
  "mime_type": "text",
  "file_type": "text",
  "storage_class": "text",
  "last_modified": "2025-06-25T04:56:26.028Z",
  "aws_account_id": 1,
  "s3_bucket_id": 1,
  "s3_bucket_name": "text",
  "data_elements": [
    "text"
  ],
  "personas": [
    "text"
  ]
}
PreviousS3NextModels

Was this helpful?