ONYPHE API

Name: ONYPHE API
Brand: ONYPHE API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentSecurityThreat DetectionapiKey9 EndpointsREST

For Agents

Search ONYPHE's internet-wide scan dataset for an IP, domain, or organisation to surface open ports, exposed services, and threat signals. Useful for agents performing attack-surface enrichment.

Install Jentic One Beta

Connect the ONYPHE API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the ONYPHE API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with ONYPHE API.

Search the ONYPHE dataset with a query string covering IPs, domains, certificates, and banners

Export bulk search results for offline analysis or downstream pipelines

Run discovery queries to map the attack surface of a target organisation or netblock

GET STARTED

Start building with ONYPHE API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI specification for ONYPHE API, keeping it validated and agent-ready. ONYPHE is a cyber-defense search engine that indexes the public internet for attack-surface discovery, attack-surface management, and cyber-threat intelligence. The v2 API exposes a query-based search across the indexed dataset, plus dedicated endpoints for export, discovery, summary, simple lookups, and alert management. Agents typically use ONYPHE to enrich an IP address, domain, or organisation with exposure data — open ports, certificates, banners, geolocation, and observed threats.

Use Cases

Patterns agents use ONYPHE API for, with concrete tasks.

★ IP Attack-Surface Enrichment

Enrich an IP address observed in logs with the ports, services, certificates, and threat signals ONYPHE has indexed for it. The simple and summary endpoints return a structured response in a single call, so a SOC agent can decide whether the address warrants deeper investigation without scripting multiple lookups.

Call GET /summary/ip:8.8.8.8 and return the list of open ports and any threat categories ONYPHE has tagged for that address.

Attack-Surface Discovery for an Organisation

Map the externally visible footprint of an organisation by combining the discovery endpoint with a domain or organisation query. The result lists hostnames, IPs, certificates, and exposed services which the agent can hand off to a vulnerability scanner or a triage queue.

Call GET /discovery/organization:"ExampleCorp" and return the unique hostnames and the count of exposed TCP services per host.

Certificate and Domain Threat Hunting

Pivot from a suspect certificate or domain to all related infrastructure ONYPHE has observed. The search endpoint accepts a structured query language, so a threat-hunting agent can chain queries (e.g. CN, SAN, fingerprint) and export the result set for downstream analysis.

Call GET /search/category:resolver+domain:example.com and return all distinct IPs that have served a certificate for the domain in the last 30 days.

AI Agent SOC Triage

Let a Jentic-orchestrated SOC agent enrich an alert with ONYPHE data without holding the API key. The agent searches Jentic for an enrichment intent, Jentic injects the apikey header at execution time, and the response is returned to the agent for decisioning.

Search Jentic for 'enrich an IP with attack-surface data', load the ONYPHE summary schema, and execute it for IP 1.2.3.4 returning open ports and any threat tags.

Key Endpoints

9 endpoints — jentic publishes the only available openapi specification for onyphe api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

GET

/search/{query}

Search the ONYPHE dataset with a QL query

GET

/summary/{query}

Get an aggregated summary for a target

GET

/simple/{category}/{query}

Per-category single-target lookup

GET

/discovery/{query}

Discover assets for an organisation or netblock

GET

/export/{query}

Stream bulk results for a query

POST

/bulk/summary/{query}

Bulk summary for multiple targets

GET

/alert/list

List alerts configured on the account

GET

/user

Get account info and remaining quota

GET

/search/{query}

Search the ONYPHE dataset with a QL query

GET

/summary/{query}

Get an aggregated summary for a target

GET

/simple/{category}/{query}

Per-category single-target lookup

GET

/discovery/{query}

Discover assets for an organisation or netblock

GET

/export/{query}

Stream bulk results for a query

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

The ONYPHE API key is stored encrypted in the Jentic vault (MAXsystem). Agents receive a scoped execution token; the 'apikey <KEY>' Authorization header is constructed at execution time so the raw key never enters the agent's context.

Intent-based discovery

Agents search Jentic with intents such as 'enrich an IP with attack-surface data' and receive the matching ONYPHE operation (search, summary, simple, or discovery) with its input schema, so the agent can pick the right granularity without reading the QL docs.

Time to first call

Direct ONYPHE integration: 2-3 days to build the QL helpers, header auth, and quota handling. Through Jentic: under 1 hour — search, load schema, execute.

FAQs

Specific to using ONYPHE API through Jentic.

Why is there no official OpenAPI spec for ONYPHE API?

ONYPHE does not publish an OpenAPI specification on its documentation site. Jentic generates and maintains this spec from the v2 API documentation so AI agents and developers can call ONYPHE via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the ONYPHE API use?

ONYPHE uses an API key passed in the Authorization header in the form 'apikey <YOUR_KEY>'. Through Jentic the key is held in the vault and the Authorization header is built at execution time, so the agent calling GET /summary/{query} never sees the raw key.

Can I run bulk exports against ONYPHE through this API?

Yes. GET /export/{query} streams full result sets for a search query, and POST /bulk/summary/{query} returns aggregated summaries for multiple targets in one call. These are the right endpoints for batch enrichment rather than the single-target /simple/ family.

What are the rate limits for the ONYPHE API?

Rate limits and result quotas depend on the ONYPHE subscription tier and are not declared in the spec. The /user endpoint returns the current credit balance and quota state, so an agent should call it at the start of a run and back off on any 429 response.

How do I enrich an IP address through Jentic?

Run pip install jentic and search for 'enrich an IP address with attack-surface data'. Jentic returns the GET /summary/{query} operation; load the schema and execute it with query like 'ip:8.8.8.8' to receive open ports, certificates, and threat tags in one response.

Does ONYPHE provide active scanning?

No. ONYPHE serves data from its own continuous internet-wide scans through these endpoints — the API does not initiate a scan against a target on demand. For active scanning use a vulnerability scanner alongside ONYPHE's passive results.