Skip to main content

Retrieve an S3 bucket connector by ID

GET 
/v1/log-shipping/s3-buckets/:id

Returns connection details for an S3 bucket connector by its ID. Please ensure to change the region in the URL to match your account's region.

Request​

Path Parameters

    id int32required

    Logz.io ID of the S3 Bucket connector. You can run the relevant GET endpoints to retrieve the ID.

Responses​

successful operation

Schema
    accessKey string

    AWS S3 bucket access key

    secretKey string

    AWS S3 bucket secret key

    arn string

    Amazon Resource Name (ARN) to uniquely identify the S3 bucket. To generate a new ARN, create a new IAM Role in your AWS admin console.

    bucket stringrequired

    AWS S3 bucket name

    prefix string

    Prefix of the AWS S3 bucket

    active boolean

    Default value: true

    If true, the S3 bucket connector is active and logs are being fetched to Logz.io. If false, the connector is disabled.

    addS3ObjectKeyAsLogField boolean

    Default value: false

    If true, enriches logs with a new field detailing the S3 object key.

    region stringrequired

    Possible values: [US_EAST_1, US_EAST_2, US_WEST_1, US_WEST_2, EU_WEST_1, EU_WEST_2, EU_WEST_3, EU_CENTRAL_1, AP_NORTHEAST_1, AP_NORTHEAST_2, AP_SOUTHEAST_1, AP_SOUTHEAST_2, SA_EAST_1, AP_SOUTH_1, CA_CENTRAL_1]

    Specify one supported AWS region.

    logsType stringrequired

    Possible values: [elb, vpcflow, S3Access, cloudfront]

    Specifies the log type being sent to Logz.io. Determines the parsing pipeline used to parse and map the logs. Learn more about parsing options supported by Logz.io.

Loading...