# Well-Known File Inventory (`junipr/well-known-file-inventory`) Actor Inventory common `.well-known` files across domains and report reachability/content hints. - **URL**: https://apify.com/junipr/well-known-file-inventory.md - **Developed by:** [junipr](https://apify.com/junipr) (community) - **Categories:** SEO tools - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing from $4.90 / 1,000 page auditeds This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js/docs.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python/docs.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## Well-Known File Inventory Normalize supplied HTTP observations for common `/.well-known/` files into domain/path inventory rows. ### Inputs - `domains`: Domains with a `files` map keyed by path. - `maxFiles`: Maximum paid file rows to emit. - `includeReport`: Create Markdown and JSON report artifacts. - `maxChargeUsd`: Stop before the next PPE event would exceed the run budget. ```json { "domains": [ { "domain": "www.google.com", "files": { "/.well-known/security.txt": { "statusCode": 200, "contentType": "text/plain", "contentLength": 275 }, "/.well-known/assetlinks.json": { "statusCode": 200, "contentType": "application/json", "contentLength": 12101 } } } ], "maxFiles": 2, "includeReport": true, "maxChargeUsd": 1 } ```` ### Dataset Rows include domain, path, constructed URL, normalized status code, found state, content type and length, parse state, file type, issues, and warnings. Any 2xx status is treated as found. Empty file maps produce no dataset rows. ### Billing The pay-per-event billing events are `actor-start`, `page-audited`, `record-extracted`, `finding-emitted`, and `audit-report-generated`. Dataset and report output is charge-gated. A zero-dollar cap emits no paid output. ### Use Cases - Inventory `security.txt` availability across domains. - Review app-association and change-password paths. - Flag missing files and missing content types. - Normalize mixed numeric/string HTTP status evidence. - Export domain/path readiness rows with a report. ### Limitations The actor evaluates supplied HTTP observations and does not fetch URLs. It does not validate the semantic contents of security contacts, mobile association files, or other path-specific formats. # Actor input Schema ## `domains` (type: `array`): Domains and observed responses for well-known paths. ## `maxFiles` (type: `integer`): Hard cap for emitted well-known file rows. ## `includeReport` (type: `boolean`): Create charged Markdown and JSON report artifacts. ## `maxChargeUsd` (type: `number`): Stop before an event would exceed this run budget. ## Actor input object example ```json { "domains": [ { "domain": "www.google.com", "files": { "/.well-known/security.txt": { "statusCode": 200, "contentType": "text/plain", "contentLength": 275 }, "/.well-known/assetlinks.json": { "statusCode": 200, "contentType": "application/json", "contentLength": 12101 } } } ], "maxFiles": 2, "includeReport": true, "maxChargeUsd": 1 } ``` # Actor output Schema ## `dataset` (type: `string`): Structured rows emitted by the actor. ## `report` (type: `string`): Run summary report stored in the default key-value store. # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = {}; // Run the Actor and wait for it to finish const run = await client.actor("junipr/well-known-file-inventory").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = {} # Run the Actor and wait for it to finish run = client.actor("junipr/well-known-file-inventory").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{}' | apify call junipr/well-known-file-inventory --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=junipr/well-known-file-inventory", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Well-Known File Inventory", "description": "Inventory common `.well-known` files across domains and report reachability/content hints.", "version": "1.0", "x-build-id": "k6AqeipNRF0eoLHGd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/junipr~well-known-file-inventory/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-junipr-well-known-file-inventory", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/junipr~well-known-file-inventory/runs": { "post": { "operationId": "runs-sync-junipr-well-known-file-inventory", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/junipr~well-known-file-inventory/run-sync": { "post": { "operationId": "run-sync-junipr-well-known-file-inventory", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "domains": { "title": "Well-known file evidence", "type": "array", "description": "Domains and observed responses for well-known paths.", "items": { "type": "object", "properties": { "domain": { "type": "string", "title": "Domain", "description": "Domain input value." }, "files": { "type": "object", "title": "Path response map", "description": "Files input value." } } }, "default": [ { "domain": "www.google.com", "files": { "/.well-known/security.txt": { "statusCode": 200, "contentType": "text/plain", "contentLength": 275 }, "/.well-known/assetlinks.json": { "statusCode": 200, "contentType": "application/json", "contentLength": 12101 } } } ] }, "maxFiles": { "title": "Maximum file rows", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard cap for emitted well-known file rows.", "default": 2 }, "includeReport": { "title": "Include report", "type": "boolean", "description": "Create charged Markdown and JSON report artifacts.", "default": true }, "maxChargeUsd": { "title": "Maximum charge USD", "minimum": 0, "maximum": 100, "type": "number", "description": "Stop before an event would exceed this run budget.", "default": 1 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } } ```