Applications API

Manage your applications programmatically.

List Applications

GET /applications

Retrieve all applications in your organization.

Query Parameters

Parameter	Type	Description
`page`	integer	Page number (default: 1)
`per_page`	integer	Items per page (default: 20, max: 100)
`status`	string	Filter by status: `active`, `paused`, `archived`
`type`	string	Filter by type: `web`, `api`, `supabase`, `firebase`

Response

{
  "data": [
    {
      "id": "app_abc123",
      "name": "Production App",
      "url": "https://app.example.com",
      "type": "web",
      "status": "active",
      "created_at": "2025-01-01T00:00:00Z",
      "last_scan_at": "2025-01-15T10:00:00Z",
      "scan_schedule": "weekly",
      "security_score": 87
    }
  ],
  "meta": {
    "total": 5,
    "page": 1,
    "per_page": 20
  }
}

Example

curl -X GET "https://api.modernpentest.com/v1/applications?status=active" \
  -H "Authorization: Bearer YOUR_API_KEY"

Get Application

GET /applications/{id}

Retrieve details for a specific application.

Path Parameters

Parameter	Type	Description
`id`	string	Application ID

Response

{
  "id": "app_abc123",
  "name": "Production App",
  "url": "https://app.example.com",
  "type": "web",
  "status": "active",
  "created_at": "2025-01-01T00:00:00Z",
  "last_scan_at": "2025-01-15T10:00:00Z",
  "scan_schedule": "weekly",
  "security_score": 87,
  "configuration": {
    "authentication": {
      "type": "bearer",
      "configured": true
    },
    "excluded_paths": ["/logout", "/admin/danger"],
    "rate_limit": 10
  },
  "statistics": {
    "total_scans": 24,
    "vulnerabilities": {
      "critical": 0,
      "high": 2,
      "medium": 5,
      "low": 8
    }
  }
}

Create Application

POST /applications

Add a new application to your organization.

Request Body

{
  "name": "New Application",
  "url": "https://new.example.com",
  "type": "web",
  "authentication": {
    "type": "bearer",
    "token": "test-token-xxx"
  },
  "configuration": {
    "excluded_paths": ["/logout"],
    "rate_limit": 10,
    "scan_schedule": "weekly"
  }
}

Parameters

Field	Type	Required	Description
`name`	string	Yes	Application name
`url`	string	Yes	Target URL
`type`	string	Yes	`web`, `api`, `supabase`, `firebase`
`authentication`	object	No	Auth configuration
`configuration`	object	No	Scan settings

Authentication Types

Bearer Token:

{
  "type": "bearer",
  "token": "your-token"
}

Basic Auth:

{
  "type": "basic",
  "username": "user",
  "password": "pass"
}

Custom Login:

{
  "type": "custom",
  "login_endpoint": "/api/auth/login",
  "credentials": {
    "email": "test@example.com",
    "password": "password"
  }
}

Response

{
  "id": "app_xyz789",
  "name": "New Application",
  "url": "https://new.example.com",
  "type": "web",
  "status": "active",
  "created_at": "2025-01-15T12:00:00Z"
}

Example

curl -X POST https://api.modernpentest.com/v1/applications \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "New Application",
    "url": "https://new.example.com",
    "type": "web"
  }'

Update Application

PATCH /applications/{id}

Update an existing application.

Request Body

{
  "name": "Updated Name",
  "status": "paused",
  "configuration": {
    "scan_schedule": "daily"
  }
}

Response

Returns the updated application object.

Delete Application

DELETE /applications/{id}

Remove an application and all associated data.

This action is irreversible. All scans, vulnerabilities, and reports for this application will be permanently deleted.

Response

{
  "deleted": true,
  "id": "app_abc123"
}

Last updated: December 8, 2025

Applications

On this page