Start gateway packet capture

POST

/

v2

/

api

/

start_gateway_packet_capture

cURL

curl -sk -X POST "https://<controller>/v2/api/start_gateway_packet_capture" \
  -H "Authorization: cid <CID>"

import requests

url = "https://<controller>/v2/api/start_gateway_packet_capture"
headers = {"Authorization": "cid <CID>"}

response = requests.post(url, headers=headers, verify=False)
print(response.status_code)
print(response.text)

package main

import (
  "fmt"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("POST", "https://<controller>/v2/api/start_gateway_packet_capture", nil)
  req.Header.Set("Authorization", "cid <CID>")

  client := &http.Client{}
  resp, err := client.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()

  fmt.Println(resp.Status)
}

{
  "errortype": "<string>",
  "reason": "<string>",
  "results": true,
  "return": true
}

{
  "errortype": "<string>",
  "reason": "<string>",
  "results": true,
  "return": true
}

Body

application/json

gateway_name

string

required

Gateway name.

interface

string

required

Interface name.

CID

string

The opaque session ID token. Required for 7.2 controllers only.

action

string

The API action to perform. Required for 7.2 controllers only.

async

string

Run asynchronously. Won't be set directly, but will be helpful for tooling.

async_request_id

string

Async request ID.

duration

string

How long to run.

host_name

string

Filter by host.

log_file

string

Full path of the progress log file.

packet_length

string

Number of bytes to capture in a packet.

port

string

Filter by port.

username

string

Unique user name.

Response

General v2 API response schema.

A generic API response container for v2 style APIs.

errortype

string

Error type if the API failed.

reason

string

Failure reason if the API failed.

results

API response data

return

boolean

Whether the API returned successfully

⌘I

cURL

curl -sk -X POST "https://<controller>/v2/api/start_gateway_packet_capture" \
  -H "Authorization: cid <CID>"

import requests

url = "https://<controller>/v2/api/start_gateway_packet_capture"
headers = {"Authorization": "cid <CID>"}

response = requests.post(url, headers=headers, verify=False)
print(response.status_code)
print(response.text)

package main

import (
  "fmt"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("POST", "https://<controller>/v2/api/start_gateway_packet_capture", nil)
  req.Header.Set("Authorization", "cid <CID>")

  client := &http.Client{}
  resp, err := client.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()

  fmt.Println(resp.Status)
}

{
  "errortype": "<string>",
  "reason": "<string>",
  "results": true,
  "return": true
}

{
  "errortype": "<string>",
  "reason": "<string>",
  "results": true,
  "return": true
}