Create new PCAP request for account.
/accounts/{account_identifier}/pcaps
post
Magic PCAP collection
magic-pcap-collection-create-pcap-request
{
"business": false,
"enterprise": true,
"free": false,
"pro": false
}null[
{
"in": "path",
"name": "account_identifier",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
}
]{
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"properties": {
"filter_v1": {
"description": "The packet capture filter. When this field is empty, all packets are captured.",
"properties": {
"destination_address": {
"description": "The destination IP address of the packet.",
"example": "1.2.3.4",
"type": "string"
},
"destination_port": {
"description": "The destination port of the packet.",
"example": 80,
"type": "number"
},
"protocol": {
"description": "The protocol number of the packet.",
"example": 6,
"type": "number"
},
"source_address": {
"description": "The source IP address of the packet.",
"example": "1.2.3.4",
"type": "string"
},
"source_port": {
"description": "The source port of the packet.",
"example": 123,
"type": "number"
}
},
"type": "object"
},
"packet_limit": {
"description": "The limit of packets contained in a packet capture.",
"example": 10000,
"maximum": 10000,
"minimum": 1,
"type": "number"
},
"system": {
"description": "The system used to collect packet captures.",
"enum": [
"magic-transit"
],
"example": "magic-transit",
"type": "string"
},
"time_limit": {
"description": "The packet capture duration in seconds.",
"example": 300,
"maximum": 300,
"minimum": 1,
"type": "number"
},
"type": {
"description": "The type of packet capture. `Simple` captures sampled packets, and `full` captures entire payloads and non-sampled packets.",
"enum": [
"simple",
"full"
],
"example": "simple",
"type": "string"
}
},
"required": [
"time_limit",
"packet_limit",
"type",
"system"
],
"type": "object"
},
{
"properties": {
"byte_limit": {
"description": "The maximum number of bytes to capture. This field only applies to `full` packet captures.",
"example": 500000,
"maximum": 1000000000,
"minimum": 1,
"type": "number"
},
"colo_name": {
"description": "The name of the data center used for the packet capture. This can be a specific colo (ord02) or a multi-colo name (ORD). This field only applies to `full` packet captures.",
"example": "ord02",
"type": "string"
},
"destination_conf": {
"description": "The full URI for the bucket. This field only applies to `full` packet captures.",
"example": "s3://pcaps-bucket?region=us-east-1",
"type": "string"
},
"filter_v1": {
"description": "The packet capture filter. When this field is empty, all packets are captured.",
"properties": {
"destination_address": {
"description": "The destination IP address of the packet.",
"example": "1.2.3.4",
"type": "string"
},
"destination_port": {
"description": "The destination port of the packet.",
"example": 80,
"type": "number"
},
"protocol": {
"description": "The protocol number of the packet.",
"example": 6,
"type": "number"
},
"source_address": {
"description": "The source IP address of the packet.",
"example": "1.2.3.4",
"type": "string"
},
"source_port": {
"description": "The source port of the packet.",
"example": 123,
"type": "number"
}
},
"type": "object"
},
"packet_limit": {
"description": "The limit of packets contained in a packet capture.",
"example": 10000,
"maximum": 10000,
"minimum": 1,
"type": "number"
},
"system": {
"description": "The system used to collect packet captures.",
"enum": [
"magic-transit"
],
"example": "magic-transit",
"type": "string"
},
"time_limit": {
"description": "The packet capture duration in seconds.",
"example": 300,
"maximum": 300,
"minimum": 1,
"type": "number"
},
"type": {
"description": "The type of packet capture. `Simple` captures sampled packets, and `full` captures entire payloads and non-sampled packets.",
"enum": [
"simple",
"full"
],
"example": "simple",
"type": "string"
}
},
"required": [
"time_limit",
"type",
"system",
"colo_name",
"destination_conf"
],
"type": "object"
}
]
}
}
},
"required": true
}{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"anyOf": [
{
"type": "object"
},
{
"type": "string"
}
]
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"anyOf": [
{
"properties": {
"filter_v1": {
"description": "The packet capture filter. When this field is empty, all packets are captured.",
"properties": {
"destination_address": {
"description": "The destination IP address of the packet.",
"example": "1.2.3.4",
"type": "string"
},
"destination_port": {
"description": "The destination port of the packet.",
"example": 80,
"type": "number"
},
"protocol": {
"description": "The protocol number of the packet.",
"example": 6,
"type": "number"
},
"source_address": {
"description": "The source IP address of the packet.",
"example": "1.2.3.4",
"type": "string"
},
"source_port": {
"description": "The source port of the packet.",
"example": 123,
"type": "number"
}
},
"type": "object"
},
"id": {
"description": "The ID for the packet capture.",
"example": "66802ca5668e47a2b82c2e6746e45037",
"maxLength": 32,
"minLength": 32,
"type": "string"
},
"status": {
"description": "The status of the packet capture request.",
"enum": [
"unknown",
"success",
"pending",
"running",
"conversion_pending",
"conversion_running",
"complete",
"failed"
],
"example": "success",
"type": "string"
},
"submitted": {
"description": "The RFC 3339 timestamp when the packet capture was created.",
"example": "2020-01-01T08:00:00Z",
"type": "string"
},
"system": {
"description": "The system used to collect packet captures.",
"enum": [
"magic-transit"
],
"example": "magic-transit",
"type": "string"
},
"time_limit": {
"description": "The packet capture duration in seconds.",
"example": 300,
"maximum": 300,
"minimum": 1,
"type": "number"
},
"type": {
"description": "The type of packet capture. `Simple` captures sampled packets, and `full` captures entire payloads and non-sampled packets.",
"enum": [
"simple",
"full"
],
"example": "simple",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"byte_limit": {
"description": "The maximum number of bytes to capture. This field only applies to `full` packet captures.",
"example": 500000,
"maximum": 1000000000,
"minimum": 1,
"type": "number"
},
"colo_name": {
"description": "The name of the data center used for the packet capture. This can be a specific colo (ord02) or a multi-colo name (ORD). This field only applies to `full` packet captures.",
"example": "ord02",
"type": "string"
},
"destination_conf": {
"description": "The full URI for the bucket. This field only applies to `full` packet captures.",
"example": "s3://pcaps-bucket?region=us-east-1",
"type": "string"
},
"error_message": {
"description": "An error message that describes why the packet capture failed. This field only applies to `full` packet captures.",
"example": "No packets matched the filter in the time limit given. Please modify the filter or try again.",
"type": "string"
},
"filter_v1": {
"description": "The packet capture filter. When this field is empty, all packets are captured.",
"properties": {
"destination_address": {
"description": "The destination IP address of the packet.",
"example": "1.2.3.4",
"type": "string"
},
"destination_port": {
"description": "The destination port of the packet.",
"example": 80,
"type": "number"
},
"protocol": {
"description": "The protocol number of the packet.",
"example": 6,
"type": "number"
},
"source_address": {
"description": "The source IP address of the packet.",
"example": "1.2.3.4",
"type": "string"
},
"source_port": {
"description": "The source port of the packet.",
"example": 123,
"type": "number"
}
},
"type": "object"
},
"id": {
"description": "The ID for the packet capture.",
"example": "66802ca5668e47a2b82c2e6746e45037",
"maxLength": 32,
"minLength": 32,
"type": "string"
},
"status": {
"description": "The status of the packet capture request.",
"enum": [
"unknown",
"success",
"pending",
"running",
"conversion_pending",
"conversion_running",
"complete",
"failed"
],
"example": "success",
"type": "string"
},
"submitted": {
"description": "The RFC 3339 timestamp when the packet capture was created.",
"example": "2020-01-01T08:00:00Z",
"type": "string"
},
"system": {
"description": "The system used to collect packet captures.",
"enum": [
"magic-transit"
],
"example": "magic-transit",
"type": "string"
},
"time_limit": {
"description": "The packet capture duration in seconds.",
"example": 300,
"maximum": 300,
"minimum": 1,
"type": "number"
},
"type": {
"description": "The type of packet capture. `Simple` captures sampled packets, and `full` captures entire payloads and non-sampled packets.",
"enum": [
"simple",
"full"
],
"example": "simple",
"type": "string"
}
},
"type": "object"
}
]
}
}
}
]
}
}
},
"description": "Create PCAP request response"
},
"default": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"anyOf": [
{
"type": "object"
},
{
"type": "string"
}
]
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"anyOf": [
{
"properties": {
"filter_v1": {
"description": "The packet capture filter. When this field is empty, all packets are captured.",
"properties": {
"destination_address": {
"description": "The destination IP address of the packet.",
"example": "1.2.3.4",
"type": "string"
},
"destination_port": {
"description": "The destination port of the packet.",
"example": 80,
"type": "number"
},
"protocol": {
"description": "The protocol number of the packet.",
"example": 6,
"type": "number"
},
"source_address": {
"description": "The source IP address of the packet.",
"example": "1.2.3.4",
"type": "string"
},
"source_port": {
"description": "The source port of the packet.",
"example": 123,
"type": "number"
}
},
"type": "object"
},
"id": {
"description": "The ID for the packet capture.",
"example": "66802ca5668e47a2b82c2e6746e45037",
"maxLength": 32,
"minLength": 32,
"type": "string"
},
"status": {
"description": "The status of the packet capture request.",
"enum": [
"unknown",
"success",
"pending",
"running",
"conversion_pending",
"conversion_running",
"complete",
"failed"
],
"example": "success",
"type": "string"
},
"submitted": {
"description": "The RFC 3339 timestamp when the packet capture was created.",
"example": "2020-01-01T08:00:00Z",
"type": "string"
},
"system": {
"description": "The system used to collect packet captures.",
"enum": [
"magic-transit"
],
"example": "magic-transit",
"type": "string"
},
"time_limit": {
"description": "The packet capture duration in seconds.",
"example": 300,
"maximum": 300,
"minimum": 1,
"type": "number"
},
"type": {
"description": "The type of packet capture. `Simple` captures sampled packets, and `full` captures entire payloads and non-sampled packets.",
"enum": [
"simple",
"full"
],
"example": "simple",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"byte_limit": {
"description": "The maximum number of bytes to capture. This field only applies to `full` packet captures.",
"example": 500000,
"maximum": 1000000000,
"minimum": 1,
"type": "number"
},
"colo_name": {
"description": "The name of the data center used for the packet capture. This can be a specific colo (ord02) or a multi-colo name (ORD). This field only applies to `full` packet captures.",
"example": "ord02",
"type": "string"
},
"destination_conf": {
"description": "The full URI for the bucket. This field only applies to `full` packet captures.",
"example": "s3://pcaps-bucket?region=us-east-1",
"type": "string"
},
"error_message": {
"description": "An error message that describes why the packet capture failed. This field only applies to `full` packet captures.",
"example": "No packets matched the filter in the time limit given. Please modify the filter or try again.",
"type": "string"
},
"filter_v1": {
"description": "The packet capture filter. When this field is empty, all packets are captured.",
"properties": {
"destination_address": {
"description": "The destination IP address of the packet.",
"example": "1.2.3.4",
"type": "string"
},
"destination_port": {
"description": "The destination port of the packet.",
"example": 80,
"type": "number"
},
"protocol": {
"description": "The protocol number of the packet.",
"example": 6,
"type": "number"
},
"source_address": {
"description": "The source IP address of the packet.",
"example": "1.2.3.4",
"type": "string"
},
"source_port": {
"description": "The source port of the packet.",
"example": 123,
"type": "number"
}
},
"type": "object"
},
"id": {
"description": "The ID for the packet capture.",
"example": "66802ca5668e47a2b82c2e6746e45037",
"maxLength": 32,
"minLength": 32,
"type": "string"
},
"status": {
"description": "The status of the packet capture request.",
"enum": [
"unknown",
"success",
"pending",
"running",
"conversion_pending",
"conversion_running",
"complete",
"failed"
],
"example": "success",
"type": "string"
},
"submitted": {
"description": "The RFC 3339 timestamp when the packet capture was created.",
"example": "2020-01-01T08:00:00Z",
"type": "string"
},
"system": {
"description": "The system used to collect packet captures.",
"enum": [
"magic-transit"
],
"example": "magic-transit",
"type": "string"
},
"time_limit": {
"description": "The packet capture duration in seconds.",
"example": 300,
"maximum": 300,
"minimum": 1,
"type": "number"
},
"type": {
"description": "The type of packet capture. `Simple` captures sampled packets, and `full` captures entire payloads and non-sampled packets.",
"enum": [
"simple",
"full"
],
"example": "simple",
"type": "string"
}
},
"type": "object"
}
]
}
}
}
]
},
{
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"enum": [
null
],
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
]
}
}
},
"description": "Create PCAP request response failure"
}
}[
{
"api_email": [],
"api_key": []
}
]