Exclusions

List Exclusions

Retrieve all exclusion rules configured for an account.

Path Parameters

string

required

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

Headers

string

required

Bearer token for authentication

Response

boolean

Indicates if there are more records to paginate through

array

Show Exclusion Objects

string

Unique exclusion rule identifier

string

Account identifier this exclusion belongs to

string

Name of the exclusion rule

string

Description of what this rule excludes

string

URL path pattern to match (supports wildcards)

string

HTTP method to match (GET, POST, PUT, DELETE, etc.) or * for all

number

HTTP status code to match (nullable, null means all status codes)

boolean

Whether this exclusion rule is currently active

string

ISO 8601 timestamp of rule creation

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

const response = await fetch('https://api.apitraffic.io/v1/accounts/acc_abc123def456ghi789jkl012/exclusions', {
  headers: {
    'Authorization': 'Bearer your-jwt-token'
  }
});

const exclusions = await response.json();
console.log(exclusions);

import requests

response = requests.get(
    'https://api.apitraffic.io/v1/accounts/acc_abc123def456ghi789jkl012/exclusions',
    headers={'Authorization': 'Bearer your-jwt-token'}
)

exclusions = response.json()
print(exclusions)

{
  "hasMore": false,
  "records": [
    {
      "sid": "exc_abc123def456ghi789jkl012",
      "accountSid": "acc_abc123def456ghi789jkl012",
      "name": "Health Check Exclusion",
      "description": "Excludes health check endpoints from monitoring",
      "pathPattern": "/health*",
      "method": "GET",
      "statusCode": null,
      "isActive": true,
      "createdAt": "2023-12-01T10:30:00.000Z"
    },
    {
      "sid": "exc_xyz789uvw012rst345abc",
      "accountSid": "acc_abc123def456ghi789jkl012",
      "name": "Static Assets",
      "description": "Excludes static asset requests",
      "pathPattern": "/static/*",
      "method": "*",
      "statusCode": null,
      "isActive": true,
      "createdAt": "2023-12-01T11:15:00.000Z"
    }
  ]
}

Get Exclusion

Retrieve details of a specific exclusion rule.

Path Parameters

string

required

Account identifier

string

required

Exclusion rule identifier

Headers

string

required

Bearer token for authentication

Response

Returns a single exclusion object with the same structure as described in the List Exclusions response.

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

const response = await fetch('https://api.apitraffic.io/v1/accounts/acc_abc123def456ghi789jkl012/exclusions/exc_abc123def456ghi789jkl012', {
  headers: {
    'Authorization': 'Bearer your-jwt-token'
  }
});

const exclusion = await response.json();
console.log(exclusion);

{
  "sid": "exc_abc123def456ghi789jkl012",
  "accountSid": "acc_abc123def456ghi789jkl012",
  "name": "Health Check Exclusion",
  "description": "Excludes health check endpoints from monitoring",
  "pathPattern": "/health*",
  "method": "GET",
  "statusCode": null,
  "isActive": true,
  "createdAt": "2023-12-01T10:30:00.000Z"
}

Create Exclusion

Create a new exclusion rule to filter out unwanted requests from monitoring.

Path Parameters

string

required

Account identifier

Headers

string

required

Bearer token for authentication

Request Body

string

required

Name of the exclusion rule

string

Description of what this rule excludes

string

required

URL path pattern to match. Supports wildcards (*) and exact matches

string

required

HTTP method to match (GET, POST, PUT, DELETE, etc.) or * for all methods

number

HTTP status code to match (optional, null means all status codes)

boolean

Whether this exclusion rule should be active (default: true)

Response

Returns the created exclusion object.

curl -X POST "https://api.apitraffic.io/v1/accounts/acc_abc123def456ghi789jkl012/exclusions" \
  -H "Authorization: Bearer your-jwt-token" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Metrics Exclusion",
    "description": "Excludes internal metrics endpoints",
    "pathPattern": "/metrics/*",
    "method": "*",
    "isActive": true
  }'

const response = await fetch('https://api.apitraffic.io/v1/accounts/acc_abc123def456ghi789jkl012/exclusions', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer your-jwt-token',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'Metrics Exclusion',
    description: 'Excludes internal metrics endpoints',
    pathPattern: '/metrics/*',
    method: '*',
    isActive: true
  })
});

const exclusion = await response.json();
console.log(exclusion);

import requests

response = requests.post(
    'https://api.apitraffic.io/v1/accounts/acc_abc123def456ghi789jkl012/exclusions',
    headers={
        'Authorization': 'Bearer your-jwt-token',
        'Content-Type': 'application/json'
    },
    json={
        'name': 'Metrics Exclusion',
        'description': 'Excludes internal metrics endpoints',
        'pathPattern': '/metrics/*',
        'method': '*',
        'isActive': True
    }
)

exclusion = response.json()
print(exclusion)

{
  "sid": "exc_new789uvw012rst345def",
  "accountSid": "acc_abc123def456ghi789jkl012",
  "name": "Metrics Exclusion",
  "description": "Excludes internal metrics endpoints",
  "pathPattern": "/metrics/*",
  "method": "*",
  "statusCode": null,
  "isActive": true,
  "createdAt": "2023-12-01T15:45:00.000Z"
}

Update Exclusion

Update an existing exclusion rule.

Path Parameters

string

required

Account identifier

string

required

Exclusion rule identifier

Headers

string

required

Bearer token for authentication

Request Body

string

required

Name of the exclusion rule

string

Description of what this rule excludes

string

required

URL path pattern to match

string

required

HTTP method to match or * for all methods

number

HTTP status code to match (optional)

boolean

required

Whether this exclusion rule should be active

Response

Returns the updated exclusion object.

curl -X PUT "https://api.apitraffic.io/v1/accounts/acc_abc123def456ghi789jkl012/exclusions/exc_abc123def456ghi789jkl012" \
  -H "Authorization: Bearer your-jwt-token" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Health Check Exclusion",
    "description": "Excludes all health check and status endpoints",
    "pathPattern": "/health*",
    "method": "*",
    "statusCode": 200,
    "isActive": true
  }'

const response = await fetch('https://api.apitraffic.io/v1/accounts/acc_abc123def456ghi789jkl012/exclusions/exc_abc123def456ghi789jkl012', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer your-jwt-token',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'Updated Health Check Exclusion',
    description: 'Excludes all health check and status endpoints',
    pathPattern: '/health*',
    method: '*',
    statusCode: 200,
    isActive: true
  })
});

const exclusion = await response.json();
console.log(exclusion);

{
  "sid": "exc_abc123def456ghi789jkl012",
  "accountSid": "acc_abc123def456ghi789jkl012",
  "name": "Updated Health Check Exclusion",
  "description": "Excludes all health check and status endpoints",
  "pathPattern": "/health*",
  "method": "*",
  "statusCode": 200,
  "isActive": true,
  "createdAt": "2023-12-01T10:30:00.000Z"
}

Delete Exclusion

Delete an exclusion rule.

Deleting an exclusion rule will cause previously excluded requests to be monitored again if they match other patterns.

Path Parameters

string

required

Account identifier

string

required

Exclusion rule identifier

Headers

string

required

Bearer token for authentication

Response

string

ID of the deleted exclusion rule

boolean

Flag indicating the exclusion rule was successfully deleted

curl -X DELETE "https://api.apitraffic.io/v1/accounts/acc_abc123def456ghi789jkl012/exclusions/exc_abc123def456ghi789jkl012" \
  -H "Authorization: Bearer your-jwt-token"

const response = await fetch('https://api.apitraffic.io/v1/accounts/acc_abc123def456ghi789jkl012/exclusions/exc_abc123def456ghi789jkl012', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer your-jwt-token'
  }
});

const result = await response.json();
console.log(result);

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

Path Pattern Examples

Exclusion rules support flexible path matching patterns:

/health
// Matches only: /health

/health*
// Matches: /health, /health-check, /healthz

*/admin
// Matches: /api/admin, /v1/admin, /internal/admin

/api/*/status
// Matches: /api/users/status, /api/orders/status

/api/*/v*/health*
// Matches: /api/users/v1/health, /api/orders/v2/healthcheck

Common Exclusion Patterns

Health Checks

{
  "name": "Health Checks",
  "pathPattern": "/health*",
  "method": "GET"
}

Static Assets

{
  "name": "Static Assets", 
  "pathPattern": "/static/*",
  "method": "*"
}

Internal APIs

{
  "name": "Internal APIs",
  "pathPattern": "/internal/*",
  "method": "*"
}

Successful Options Requests

{
  "name": "CORS Preflight",
  "pathPattern": "*",
  "method": "OPTIONS",
  "statusCode": 200
}

Admin Endpoints

{
  "name": "Admin Panel",
  "pathPattern": "/admin/*",
  "method": "*"
}

API Documentation

Core Resources

Data Management

Automation

List Exclusions

Path Parameters

Headers

Response

Get Exclusion

Path Parameters

Headers

Response

Create Exclusion

Path Parameters

Headers

Request Body

Response

Update Exclusion

Path Parameters

Headers

Request Body

Response

Delete Exclusion

Path Parameters

Headers

Response

Path Pattern Examples

Common Exclusion Patterns

Health Checks

Static Assets

Internal APIs

Successful Options Requests

Admin Endpoints

​List Exclusions

​Path Parameters

​Headers

​Response

​Get Exclusion

​Path Parameters

​Headers

​Response

​Create Exclusion

​Path Parameters

​Headers

​Request Body

​Response

​Update Exclusion

​Path Parameters

​Headers

​Request Body

​Response

​Delete Exclusion

​Path Parameters

​Headers

​Response

​Path Pattern Examples

​Common Exclusion Patterns

​Health Checks

​Static Assets

​Internal APIs

​Successful Options Requests

​Admin Endpoints

List Exclusions

Path Parameters

Headers

Response

Get Exclusion

Path Parameters

Headers

Response

Create Exclusion

Path Parameters

Headers

Request Body

Response

Update Exclusion

Path Parameters

Headers

Request Body

Response

Delete Exclusion

Path Parameters

Headers

Response

Path Pattern Examples

Common Exclusion Patterns

Health Checks

Static Assets

Internal APIs

Successful Options Requests

Admin Endpoints