List PCAPs Bucket Ownership

List all buckets configured for use with PCAPs API.

application/json

Body

result

required

Any of

allOf {2}

array[object (pcaps_ownership_response) {6}]

allOf {2}

One of

array[object (pcaps_ownership_response) {6}] | null

object

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

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

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

result_info

object

result_info

optional

count

number

optional

Total number of results for the requested service

Example:

page

number

optional

Current page within paginated list of results

Example:

per_page

number

optional

Number of results per page of results

Example:

total_count

number

optional

Total results available without any search parameters

Example:

2000

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,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

List PCAPs Bucket Ownership

Request

Request samples

Responses