Contrastsecurity Contrast Agent Dashboard API

Name: Contrast Agent Dashboard API
Brand: Contrast Agent Dashboard API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentSecurityVulnerability ManagementapiKey9 EndpointsREST

For Agents

Install Jentic One Beta

Connect the Contrast Agent Dashboard API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Contrast Agent Dashboard 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://jentic.com/install.sh?src=apis&api=%2Fapis%2Fcontrastsecurity.com%2Fcontrastsecurity" | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fcontrastsecurity.com%2Fcontrastsecurity" | 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 Contrast Agent Dashboard API.

List agents deployed in a Contrast organisation with grouping by application, server, or hostname

Read the latest agent versions available for upgrade planning

Retrieve a specific agent instance's status on a specific application

GET STARTED

Start building with Contrast Agent Dashboard API

Explore with Jentic One

View OpenAPI Document

Use Cases

Patterns agents use Contrast Agent Dashboard API for, with concrete tasks.

★ Agent Coverage and Drift Audit

Security operations teams use the Agent Dashboard API to confirm that every production application in scope is reporting a Contrast agent and that the deployed agent version is within policy. Endpoints group agents by application, server, and hostname to surface coverage gaps and drift. This gives auditors a programmatic answer to 'is Contrast running everywhere we expect?' rather than a manual spreadsheet.

GET /api/v4/organizations/{organizationId}/agents/applications-group-by, then GET /api/v4/organizations/{organizationId}/agents/latest-versions, and report applications running an agent version older than the latest

Configuration Override Review

Application security engineers review which Contrast agents have configuration values overridden from defaults - a common source of detection gaps when teams disable rules. The effective-config and overridden endpoints make this review automated rather than per-application clicking, and the result feeds change-control records for each application.

GET /api/v4/organizations/{organizationId}/agents/{agentReportingInstanceId}/applications/{applicationId}/effective-config/overridden for each agent and flag any agents with disabled detection rules

Hostname Inventory Mapping

Infrastructure teams cross-reference the Contrast server inventory with their CMDB to ensure each running host has a known owner. GET /api/v4/organizations/{organizationId}/servers/hostnames returns the hostnames Contrast is reporting from, which can be diffed against CMDB data to find rogue hosts or hosts missing the agent. This avoids relying on agent self-reports alone.

GET /api/v4/organizations/{organizationId}/servers/hostnames and join the result against a CMDB export to flag hosts present in CMDB but missing in Contrast

AI Agent SecOps Helper via Jentic

An AI agent supporting security operations uses Jentic to answer questions about Contrast deployment without engineers logging into the dashboard. The agent searches Jentic for 'list contrast agents', loads the schema, and queries the organisation's agents and effective config. Through Jentic the API-Key and Authorization headers are stored in your Jentic One instance and never enter the agent's context.

Search Jentic for 'list contrast security agents', execute with the organizationId, and return a table of agents with their version and reporting host

Key Endpoints

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

METHOD

PATH

DESCRIPTION

GET

/api/v4/organizations/{organizationId}/agents

List agents in an organisation

GET

/api/v4/organizations/{organizationId}/agents/latest-versions

Get latest available agent versions

GET

/api/v4/organizations/{organizationId}/agents/applications-group-by

Group agents by application

GET

/api/v4/organizations/{organizationId}/agents/servers-group-by

Group agents by server

GET

/api/v4/organizations/{organizationId}/agents/hostnames-group-by

Group agents by hostname

GET

/api/v4/organizations/{organizationId}/agents/{agentInstanceId}/applications/{applicationId}

Read a specific agent instance on an application

GET

/api/v4/organizations/{organizationId}/agents/{agentReportingInstanceId}/applications/{applicationId}/effective-config

Read effective agent configuration

GET

/api/v4/organizations/{organizationId}/servers/hostnames

List hostnames in the server inventory

GET

/api/v4/organizations/{organizationId}/agents

List agents in an organisation

GET

/api/v4/organizations/{organizationId}/agents/latest-versions

Get latest available agent versions

GET

/api/v4/organizations/{organizationId}/agents/applications-group-by

Group agents by application

GET

/api/v4/organizations/{organizationId}/agents/servers-group-by

Group agents by server

GET

/api/v4/organizations/{organizationId}/agents/hostnames-group-by

Group agents by hostname

Why Jentic?

What agents get from Jentic-routed access to this vendor.

Setup

Wiring the Contrast Agent Dashboard API by hand means sending both the API-Key and Authorization headers, pointing at your own Contrast instance host rather than a fixed one, and mapping the agent inventory reads yourself. Through Jentic you install once, import the Contrast Agent Dashboard API from the API Directory, store the credentials once, and your agent calls it.

Permission scoping

Contrast puts the organization id in the URL path (/api/v4/organizations/{organizationId}/agents), so a rule can pin your agent to one organization and nothing else. Since this is a read-only agent and configuration surface, the agent can only inventory agents and read their effective configuration, with nothing to modify or delete.

Credential isolation

Your Contrast API-Key and Authorization credentials are stored once, encrypted, by your own Jentic One instance and injected into the request headers at execution time. They never enter the agent's prompt, logs, or context.

Intent-based discovery

Agents search Jentic by intent such as 'list Contrast agents in an organization' or 'read an agent's effective configuration', and Jentic returns the matching operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

FAQs

Specific to using Contrast Agent Dashboard API through Jentic.

Why is there no official OpenAPI spec for Contrast Agent Dashboard API?

Contrast Security publishes API documentation at docs.contrastsecurity.com but does not host a stable OpenAPI 3 file at a permanent URL. Jentic generates and maintains this spec so that AI agents and developers can call Contrast Agent Dashboard API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

What authentication does the Contrast Agent Dashboard API use?

Each request must include both a Contrast API-Key header and an Authorization header containing the user authentication value. Through Jentic both credentials are held in your Jentic One instance and applied at call time, so the agent never sees the raw API key or auth token.

Can I list deployed Contrast agents with the Contrast Agent Dashboard API?

Yes. GET /api/v4/organizations/{organizationId}/agents lists agents in the organisation and the applications-group-by, servers-group-by, and hostnames-group-by endpoints provide aggregate views suitable for coverage dashboards.

What are the rate limits for the Contrast Agent Dashboard API?

Contrast Security applies per-organisation rate limits sized to the customer's plan; precise limits are documented in the Contrast API reference and enforced with HTTP 429. Through Jentic, retries with exponential backoff are handled at the SDK level so transient throttling does not surface to agent code.

How do I check effective agent configuration with the Contrast Agent Dashboard API through Jentic?

Run `jentic.search('get contrast agent effective configuration')`, load the operation, and execute with organizationId, agentReportingInstanceId, and applicationId. Jentic resolves this to GET /api/v4/organizations/{organizationId}/agents/{agentReportingInstanceId}/applications/{applicationId}/effective-config.

Does the Contrast Agent Dashboard API support self-hosted instances?

Yes. The base URL is templated as https://{baseUrl} with a default of app.contrastsecurity.com but can be set to any Contrast instance hostname (Enterprise on-premises or hosted). Configure the baseUrl variable to point at your Contrast deployment.

Can I limit what my agent is allowed to do with the Contrast Agent Dashboard API?

Yes. Because you run Jentic One yourself, your own rules decide which operations and credentials the agent may use. The organization id sits in the URL path (/api/v4/organizations/{organizationId}/agents), so you can pin the agent to a single organization and no other. This API is read-only, so the agent can only inventory agents and read their effective configuration, with no operations that modify or delete anything.