{ "opencollection": "1.0.0", "info": { "name": "Kernel API Keys Proxies API", "version": "0.1.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Proxies", "type": "folder" }, "items": [ { "info": { "name": "List proxies", "type": "http" }, "http": { "method": "GET", "url": "https://api.onkernel.com/proxies", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Limit the number of proxies to return." }, { "name": "offset", "value": "", "type": "query", "description": "Offset the number of proxies to return." }, { "name": "query", "value": "", "type": "query", "description": "Case-insensitive substring match against proxy name, host, or IP address. IDs match by exact value." }, { "name": "name", "value": "", "type": "query", "description": "Exact-match filter on proxy name using the database collation. In production, matching is case- and accent-insensitive. Names are not required to be unique, so multiple proxies may match." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List proxies in the resolved project." }, { "info": { "name": "Create a proxy", "type": "http" }, "http": { "method": "POST", "url": "https://api.onkernel.com/proxies", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new proxy configuration in the resolved project." }, { "info": { "name": "Get proxy by ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.onkernel.com/proxies/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieve a proxy in the resolved project by ID." }, { "info": { "name": "Rename proxy by ID", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.onkernel.com/proxies/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update a proxy's name. Proxy names are not unique and are not ID-or-name addressable on this endpoint; duplicate names are allowed. Name-based session-create lookups can remain ambiguous until callers resolve proxies by ID or the API adds a stronger uniqueness contract." }, { "info": { "name": "Delete proxy by ID", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.onkernel.com/proxies/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Soft delete a proxy. Sessions referencing it are not modified." }, { "info": { "name": "Check proxy health", "type": "http" }, "http": { "method": "POST", "url": "https://api.onkernel.com/proxies/:id/check", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Run a health check on the proxy to verify it's working. Optionally specify a URL to test reachability against a specific target. For ISP and datacenter proxies, this reliably tests whether the target site is reachable from the proxy's stable exit IP. For residential and mobile proxies, the exit node varies between requests, so this validates proxy configuration and connectivity rather than guaranteeing site-specific reachability." } ] } ], "bundled": true }