Validate buckets for full packet captures

Validates buckets added to the packet captures API.

Request

Path Params

account_identifier

string

required

Body Params application/json

destination_conf

string

required

The full URI for the bucket. This field only applies to full packet captures.

Example:

s3://pcaps-bucket?region=us-east-1

ownership_challenge

string

required

The ownership challenge filename stored in the bucket.

Example:

ownership-challenge-9883874ecac311ec8475433579a6bf5f.txt

Example

{
    "destination_conf": "s3://pcaps-bucket?region=us-east-1",
    "ownership_challenge": "ownership-challenge-9883874ecac311ec8475433579a6bf5f.txt"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Validate buckets for full packet captures response

application/json

Body

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

result

pcaps_ownership_response

required

Any of

object

allOf {2}

destination_conf

string

pcaps_destination_conf

required

The full URI for the bucket. This field only applies to full packet captures.

Example:

s3://pcaps-bucket?region=us-east-1

filename

string

pcaps_ownership_challenge

required

The ownership challenge filename stored in the bucket.

Example:

ownership-challenge-9883874ecac311ec8475433579a6bf5f.txt

string

required

The bucket ID associated with the packet captures API.

>= 32 characters<= 32 characters

Example:

9883874ecac311ec8475433579a6bf5f

status

enum<string>

required

The status of the ownership challenge. Can be pending, success or failed.

Allowed values:

pendingsuccessfailed

Example:

success

submitted

string

required

The RFC 3339 timestamp when the bucket was added to packet captures API.

Example:

2020-01-01T08:00:00Z

validated

string

optional

The RFC 3339 timestamp when the bucket was validated.

Example:

2020-01-01T08:00:00Z

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

Example

{
    "errors": [],
    "messages": [],
    "result": {
        "destination_conf": "s3://pcaps-bucket?region=us-east-1",
        "filename": "ownership-challenge-9883874ecac311ec8475433579a6bf5f.txt",
        "id": "9883874ecac311ec8475433579a6bf5f",
        "status": "success",
        "submitted": "2020-01-01T08:00:00Z",
        "validated": "2020-01-01T08:00:00Z"
    },
    "success": true
}

🟢200Validate buckets for full packet captures response failure