Requests

List Requests

Retrieve all requests captured in a specific bucket.

Path Parameters

accountSid

string

required

Account identifier (format: acc_ followed by 27 alphanumeric characters)

bucketSid

string

required

Bucket identifier

Headers

Authorization

string

required

Bearer token for authentication

Response

hasMore

boolean

Indicates if there are more records to paginate through

records

array

Show Request Objects

sid

string

Request identifier (format: req_ followed by 27 alphanumeric characters)

bucketSid

string

Bucket identifier this request belongs to

environmentSid

string

Environment identifier (6 character alphanumeric, nullable)

contextSid

string

Request context identifier (nullable)

direction

string

Request direction: in (inbound) or out (outbound)

note

string

User-added notes for the request (nullable)

createdAt

string

ISO 8601 timestamp when request was created

receivedAt

string

ISO 8601 timestamp when request was received

firewall

object

Show Firewall Information

blocked

boolean

Whether the request was blocked by firewall rules

request

object

Show Request Details

host

string

Request host (nullable)

method

string

HTTP method (nullable)

path

string

Request path (nullable)

port

number

Request port (nullable)

url

string

Full request URL (nullable)

queryString

object

Query string parameters

headers

object

Request headers as key-value pairs

body

any

Request body content

contentType

string

Content type of the request (nullable)

size

number

Size of request payload in bytes (nullable)

response

object

Show Response Details

statusCode

number

HTTP status code returned (nullable)

headers

object

Response headers as key-value pairs (nullable)

size

number

Size of response payload in bytes (nullable)

body

any

Response body content

contentType

string

Content type of the response (nullable)

timings

object

Show Performance Timings

duration

number

Total request duration in milliseconds (nullable)

start

number

Request start time (nullable)

end

number

Request end time (nullable)

lookup

number

DNS lookup time (nullable)

socket

number

Socket assignment time (nullable)

upload

number

Upload completion time (nullable)

connect

number

Connection establishment time (nullable)

response

number

Response start time (nullable)

curl -X GET "https://api.apitraffic.io/v1/accounts/acc_abc123def456ghi789jkl012/buckets/bkt_xyz789uvw012rst345abc/requests" \
  -H "Authorization: Bearer your-jwt-token"

{
  "hasMore": false,
  "records": [
    {
      "sid": "req_abc123def456ghi789jkl012mno",
      "bucketSid": "bkt_xyz789uvw012rst345abc",
      "environmentSid": "env123",
      "contextSid": null,
      "direction": "in",
      "note": null,
      "createdAt": "2023-12-01T10:30:00.000Z",
      "receivedAt": "2023-12-01T10:30:00.100Z",
      "firewall": {
        "blocked": false
      },
      "request": {
        "host": "api.example.com",
        "method": "GET",
        "path": "/users/123",
        "port": 443,
        "url": "https://api.example.com/users/123",
        "queryString": {},
        "headers": {
          "user-agent": "Mozilla/5.0",
          "accept": "application/json"
        },
        "body": null,
        "contentType": null,
        "size": 0
      },
      "response": {
        "statusCode": 200,
        "headers": {
          "content-type": "application/json",
          "content-length": "156"
        },
        "size": 156,
        "body": {
          "id": 123,
          "name": "John Doe",
          "email": "john@example.com"
        },
        "contentType": "application/json"
      },
      "timings": {
        "duration": 245,
        "start": 1701423000000,
        "end": 1701423000245,
        "lookup": 12,
        "socket": 25,
        "upload": 30,
        "connect": 45,
        "response": 200
      }
    }
  ]
}

Get Request

Retrieve details of a specific request.

Path Parameters

accountSid

string

required

Account identifier

bucketSid

string

required

Bucket identifier

requestSid

string

required

Request identifier

Headers

Authorization

string

required

Bearer token for authentication

Response

Returns a single request object with the same structure as described in the List Requests response.

curl -X GET "https://api.apitraffic.io/v1/accounts/acc_abc123def456ghi789jkl012/buckets/bkt_xyz789uvw012rst345abc/requests/req_abc123def456ghi789jkl012mno" \
  -H "Authorization: Bearer your-jwt-token"

{
  "sid": "req_abc123def456ghi789jkl012mno",
  "bucketSid": "bkt_xyz789uvw012rst345abc",
  "environmentSid": "env123",
  "contextSid": null,
  "direction": "in",
  "note": null,
  "createdAt": "2023-12-01T10:30:00.000Z",
  "receivedAt": "2023-12-01T10:30:00.100Z",
  "firewall": {
    "blocked": false
  },
  "request": {
    "host": "api.example.com",
    "method": "GET",
    "path": "/users/123",
    "port": 443,
    "url": "https://api.example.com/users/123",
    "queryString": {},
    "headers": {
      "user-agent": "Mozilla/5.0",
      "accept": "application/json"
    },
    "body": null,
    "contentType": null,
    "size": 0
  },
  "response": {
    "statusCode": 200,
    "headers": {
      "content-type": "application/json",
      "content-length": "156"
    },
    "size": 156,
    "body": {
      "id": 123,
      "name": "John Doe",
      "email": "john@example.com"
    },
    "contentType": "application/json"
  },
  "timings": {
    "duration": 245,
    "start": 1701423000000,
    "end": 1701423000245,
    "lookup": 12,
    "socket": 25,
    "upload": 30,
    "connect": 45,
    "response": 200
  }
}

Update Request

Update details of a specific request (typically used to add notes or modify metadata).

Path Parameters

accountSid

string

required

Account identifier

bucketSid

string

required

Bucket identifier

requestSid

string

required

Request identifier

Headers

Authorization

string

required

Bearer token for authentication

Request Body

note

string

Add or update notes for the request

Response

Returns the updated request object.

curl -X PUT "https://api.apitraffic.io/v1/accounts/acc_abc123def456ghi789jkl012/buckets/bkt_xyz789uvw012rst345abc/requests/req_abc123def456ghi789jkl012mno" \
  -H "Authorization: Bearer your-jwt-token" \
  -H "Content-Type: application/json" \
  -d '{
    "note": "This request was flagged for review"
  }'

{
  "sid": "req_abc123def456ghi789jkl012mno",
  "bucketSid": "bkt_xyz789uvw012rst345abc",
  "environmentSid": "env123",
  "contextSid": null,
  "direction": "in",
  "note": "This request was flagged for review",
  "createdAt": "2023-12-01T10:30:00.000Z",
  "receivedAt": "2023-12-01T10:30:00.100Z",
  "firewall": {
    "blocked": false
  },
  "request": {
    "host": "api.example.com",
    "method": "GET",
    "path": "/users/123",
    "port": 443,
    "url": "https://api.example.com/users/123",
    "queryString": {},
    "headers": {
      "user-agent": "Mozilla/5.0",
      "accept": "application/json"
    },
    "body": null,
    "contentType": null,
    "size": 0
  },
  "response": {
    "statusCode": 200,
    "headers": {
      "content-type": "application/json",
      "content-length": "156"
    },
    "size": 156,
    "body": {
      "id": 123,
      "name": "John Doe",
      "email": "john@example.com"
    },
    "contentType": "application/json"
  },
  "timings": {
    "duration": 245,
    "start": 1701423000000,
    "end": 1701423000245,
    "lookup": 12,
    "socket": 25,
    "upload": 30,
    "connect": 45,
    "response": 200
  }
}

Delete Request

Delete a specific request from the bucket.

This action is irreversible. The request data will be permanently deleted.

Path Parameters

accountSid

string

required

Account identifier

bucketSid

string

required

Bucket identifier

requestSid

string

required

Request identifier

Headers

Authorization

string

required

Bearer token for authentication

Response

sid

string

ID of the deleted request

deleted

boolean

Flag indicating the request was successfully deleted

curl -X DELETE "https://api.apitraffic.io/v1/accounts/acc_abc123def456ghi789jkl012/buckets/bkt_xyz789uvw012rst345abc/requests/req_abc123def456ghi789jkl012mno" \
  -H "Authorization: Bearer your-jwt-token"

{
  "sid": "req_abc123def456ghi789jkl012mno",
  "deleted": true
}

API Documentation

Core Resources

Data Management

Automation

List Requests

Path Parameters

Headers

Response

Get Request

Path Parameters

Headers

Response

Update Request

Path Parameters

Headers

Request Body

Response

Delete Request

Path Parameters

Headers

Response

API Documentation

Core Resources

Data Management

Automation

​List Requests

​Path Parameters

​Headers

​Response

​Get Request

​Path Parameters

​Headers

​Response

​Update Request

​Path Parameters

​Headers

​Request Body

​Response

​Delete Request

​Path Parameters

​Headers

​Response

List Requests

Path Parameters

Headers

Response

Get Request

Path Parameters

Headers

Response

Update Request

Path Parameters

Headers

Request Body

Response

Delete Request

Path Parameters

Headers

Response