Update an S3 input location

patch

https://api.pixop.com/api/v1/input-locations/s3/{id}

Updates the details of an existing S3 input location by its unique identifier.

Path Params

uuid

required

The unique identifier for the object.

Body Params

Fields of an S3 input location that can be updated.

Represents the fields that can be updated for an S3 input location, including the bucket, access keys, and name.

bucket

string

length between 3 and 63

The name of the S3 bucket. Bucket names must comply with the rules for DNS-compliant names, with a length between 3 and 63 characters.

accessKey

string

The access key for authenticating with the S3 bucket. This key is part of the AWS credentials required to perform operations on the bucket.

secretAccessKey

string

The secret access key for authenticating with the S3 bucket. This key is part of the AWS credentials and should be kept secure.

name

string

length between 1 and 47

A user-defined name to associate with the input location. Helps in organizing and identifying various input locations.

Responses

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

*/*

200Successfully retrieved details of the S3 input location.