OrgsSetting

setOrgCustomBucket

POST
/api/v1/orgs/{org_id}/setting/pcap_bucket/setup

Start custom packet capture bucket setup by saving the bucket name and having Mist write a MIST_TOKEN file to the bucket. Complete ownership verification with the verify endpoint by submitting the token contents.

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

  • An API token generated for a specific admin has the same privileges as that admin
  • An API token is automatically removed if it is not used for more than 90 days
  • SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

Path Parameters

org_id*string
Formatuuid

Request Body

application/json

Request Body

Request to configure a custom packet capture bucket

bucket*string

Customer bucket name to use for packet capture files

Response Body

curl -X POST "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/setting/pcap_bucket/setup" \  -H "Content-Type: application/json" \  -d '{    "bucket": "company-private-pcap"  }'

{  "bucket": "company-private-pcap",  "detail": "failed to write bucket - 403 AccessDenied"}