API ReferenceChangelog
Log In
API Reference

Create a new S3 input location

post
https://api.pixop.com/api/v1/input-locations/s3

Creates a new S3 input location for the selected team, which can be used with the POST /v1/videos/in/s3/{inputLocationId} endpoint to create a master video record from video data stored in the bucket defined in the S3 input location.

Query Params
uuid

Specifies the team ID for the operation.

  • For POST requests, assigns the new object to the specified team.
  • For GET requests, retrieves data for the specified team. If not provided, defaults to the ID of the default team associated with the API key.
Body Params

Fields required for creating a new S3 input location.

string
required
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.

string
required

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

string
required

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

string
required
length between 1 and 47

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

Responses

Updated about 1 year ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago