{ "openapi": "3.0.1", "info": { "title": "Docker Hub Repository Scraper", "description": "Collect Docker Hub repository records through keyword searches, publisher listings or direct lookups. Results include repository names, publishers, descriptions, pull and star counts, update dates and official status; optionally include recent tags and their architectures.", "version": "0.1", "x-build-id": "l9CTGb1QYapgEDDJr" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/axiomworks~docker-hub-image-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-axiomworks-docker-hub-image-scraper", "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/axiomworks~docker-hub-image-scraper/runs": { "post": { "operationId": "runs-sync-axiomworks-docker-hub-image-scraper", "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/axiomworks~docker-hub-image-scraper/run-sync": { "post": { "operationId": "run-sync-axiomworks-docker-hub-image-scraper", "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": { "searchQueries": { "title": "Docker Hub search terms (postgres)", "type": "array", "description": "Search terms or Docker Hub search URLs, e.g. [\"postgres\", \"https://hub.docker.com/search?q=redis\"]. URLs supply q or query only; set filters below separately. Supply searchQueries, repositories or namespaces. No default search for API calls. Unmatched or blocked targets produce no rows. Up to about 10,000 results per term; maxItems is shared across targets.", "items": { "type": "string" } }, "repositories": { "title": "Repository names or Docker Hub URLs", "type": "array", "description": "Repository strings, e.g. [\"grafana/grafana\", \"nginx\", \"https://hub.docker.com/_/postgres\"]. Bare names mean library/name. Optional when searchQueries or namespaces is supplied; default []. Unknown, private or unavailable repositories produce no rows; check the name or use a public repository.", "default": [], "items": { "type": "string" } }, "namespaces": { "title": "Publisher names or Docker Hub URLs", "type": "array", "description": "Publisher names or URLs, e.g. [\"grafana\", \"https://hub.docker.com/u/bitnami\"]. Lists public repositories under each publisher. Optional when searchQueries or repositories is supplied; default []. Unknown publishers produce no rows; check the publisher spelling.", "default": [], "items": { "type": "string" } }, "maxItems": { "title": "Max repositories", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum repositories across all searchQueries, repositories and namespaces combined, 1-10000, e.g. 10; default 50. Duplicate repositories appear once. Filters can produce fewer rows. Tags do not count toward this shared limit.", "default": 50 }, "includeTags": { "title": "Include recent tags (true or false)", "type": "boolean", "description": "Set true to include recent tags with name, fullSize, digest, lastPushed, lastUpdated and architectures, e.g. true; default true. Adds one request per repository. Set false for metadata only (tags is null). maxTagsPerRepo controls the tag count, not maxItems.", "default": true }, "maxTagsPerRepo": { "title": "Max tags per repository", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum recent tags per repository, 1-100, e.g. 3; default 5. Only used when includeTags is true. Returns fewer if the repository has fewer tags; independent of the shared maxItems repository limit.", "default": 5 }, "includeFullDescription": { "title": "Include repository README (true or false)", "type": "boolean", "description": "Set true to add fullDescription containing the repository README, e.g. true; default false omits the field. May require one extra detail request per search or namespace result. A missing README is null.", "default": false }, "onlyOfficial": { "title": "Keep Docker Official Images (true or false)", "type": "boolean", "description": "Set true to keep Docker Official Images only, e.g. true; default false includes community images. Filtered repositories do not count toward maxItems. If no rows match, set false or choose an official image such as nginx.", "default": false }, "minStars": { "title": "Minimum stars", "minimum": 0, "type": "integer", "description": "Skip repositories with fewer stars than this, e.g. 100. 0 disables the filter. Default 0.", "default": 0 }, "minPulls": { "title": "Minimum pulls", "minimum": 0, "type": "integer", "description": "Skip repositories with fewer total pulls than this, e.g. 1000000. 0 disables the filter. Default 0.", "default": 0 }, "enrichWithAi": { "title": "Classify image purpose with AI (true or false)", "type": "boolean", "description": "Set true to request category classification from a third-party AI processor using the repository name and description, e.g. true; default false. Requires the configured AI service. Successful classifications add category; unavailable or failed enrichment does not prevent repository output.", "default": false }, "proxyConfiguration": { "title": "Apify Proxy connection settings", "type": "object", "description": "Connection settings, e.g. {\"useApifyProxy\": false} (default). Public Docker Hub API requests run directly by default. Enable Apify Proxy if requests are blocked or rate limited (429). Unavailable targets are skipped; check the target and retry with proxy enabled.", "default": { "useApifyProxy": false } } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }