Validates buckets added to the packet captures API.
/accounts/{account_identifier}/pcaps/ownership/validate
post
Magic PCAP collection
magic-pcap-collection-validate-buckets-for-full-packet-captures
{
"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": {
"properties": {
"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"
},
"ownership_challenge": {
"description": "The ownership challenge filename stored in the bucket.",
"example": "ownership-challenge-9883874ecac311ec8475433579a6bf5f.txt",
"type": "string"
}
},
"required": [
"destination_conf",
"ownership_challenge"
],
"type": "object"
}
}
},
"required": true
}{
"200": {
"content": {
"application/json": {
"schema": {
"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": {
"properties": {
"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"
},
"filename": {
"description": "The ownership challenge filename stored in the bucket.",
"example": "ownership-challenge-9883874ecac311ec8475433579a6bf5f.txt",
"type": "string"
},
"id": {
"description": "The bucket ID associated with the packet captures API.",
"example": "9883874ecac311ec8475433579a6bf5f",
"maxLength": 32,
"minLength": 32,
"type": "string"
},
"status": {
"description": "The status of the ownership challenge. Can be pending, success or failed.",
"enum": [
"pending",
"success",
"failed"
],
"example": "success",
"type": "string"
},
"submitted": {
"description": "The RFC 3339 timestamp when the bucket was added to packet captures API.",
"example": "2020-01-01T08:00:00Z",
"type": "string"
},
"validated": {
"description": "The RFC 3339 timestamp when the bucket was validated.",
"example": "2020-01-01T08:00:00Z",
"type": "string"
}
},
"required": [
"id",
"status",
"submitted",
"destination_conf",
"filename"
],
"type": "object"
}
}
}
]
}
}
},
"description": "Validate buckets for full packet captures response"
},
"default": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"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": {
"properties": {
"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"
},
"filename": {
"description": "The ownership challenge filename stored in the bucket.",
"example": "ownership-challenge-9883874ecac311ec8475433579a6bf5f.txt",
"type": "string"
},
"id": {
"description": "The bucket ID associated with the packet captures API.",
"example": "9883874ecac311ec8475433579a6bf5f",
"maxLength": 32,
"minLength": 32,
"type": "string"
},
"status": {
"description": "The status of the ownership challenge. Can be pending, success or failed.",
"enum": [
"pending",
"success",
"failed"
],
"example": "success",
"type": "string"
},
"submitted": {
"description": "The RFC 3339 timestamp when the bucket was added to packet captures API.",
"example": "2020-01-01T08:00:00Z",
"type": "string"
},
"validated": {
"description": "The RFC 3339 timestamp when the bucket was validated.",
"example": "2020-01-01T08:00:00Z",
"type": "string"
}
},
"required": [
"id",
"status",
"submitted",
"destination_conf",
"filename"
],
"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": "Validate buckets for full packet captures response failure"
}
}[
{
"api_email": [],
"api_key": []
}
]