Microcks API v1.7

Name: Microcks API v1.7 API
Brand: Microcks API v1.7
Availability: InStock

✓ Official Vendor SpecDeveloper ToolsTesting Qaoauth244 EndpointsREST

For Agents

Manage mocked services, run import jobs, kick off contract tests, and inspect Microcks test results so agents can drive an internal mocking and testing platform.

Install Jentic One Beta

Connect the Microcks API v1.7 to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Microcks API v1.7, 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 Microcks API v1.7 API.

List, retrieve, and delete services and APIs registered in Microcks

Create, schedule, activate, start, and stop import jobs that ingest API artefacts

Upload artefacts directly via /artifact/upload for one-off imports

GET STARTED

Start building with Microcks API v1.7 API

Explore with Jentic

View OpenAPI Document

Use Cases

Patterns agents use Microcks API v1.7 API for, with concrete tasks.

★ Continuous Mock Refresh from Source Repos

Platform teams configure Microcks ImportJobs that periodically pull OpenAPI or AsyncAPI artefacts from a Git repository so that mocks always match the latest contract. The /jobs endpoints create and schedule the job, /jobs/{id}/start runs it on demand, and /artifact/upload covers the case where an artefact is staged from CI rather than pulled.

Create an ImportJob via POST /jobs pointing at the OpenAPI artefact URL, then PUT /jobs/{id}/start to run it immediately.

Contract Testing in CI Pipelines

QA and platform teams trigger Microcks tests from CI by calling POST /tests with a target service, version, and runner type, then poll GET /tests/{id} for results and use /tests/{id}/messages/{testCaseId} to retrieve the request/response samples for any failures. This produces evidence-rich contract test runs without leaving the pipeline.

Submit POST /tests for service ID 'svc_42' against the staging endpoint, poll GET /tests/{id} until completion, and return any failed TestCases.

Snapshot Promotion Across Environments

Teams promoting mock and test definitions across environments use POST /import and GET /export to move a Microcks snapshot from staging to production. Combined with /secrets management, the same import-export workflow works for environments that pull artefacts from private locations.

Call GET /export to capture the staging snapshot, then POST /import in production with the same payload.

Agent-Operated Mock Platform

An AI agent on a developer experience team can drive Microcks through Jentic — refreshing mocks after a contract change, kicking off tests, and surfacing failures in chat. The agent searches by intent, loads the right schema for /jobs, /tests, or /services, and executes with the JWT handled inside the Jentic vault.

Search Jentic for 'run a contract test in Microcks', load POST /tests, and submit a test for the most recently imported service.

Key Endpoints

44 endpoints — microcks is the kubernetes-native open-source tool for api and microservices mocking and contract testing.

METHOD

PATH

DESCRIPTION

GET

/services

List Services and APIs registered in Microcks

POST

/jobs

Create an ImportJob

PUT

/jobs/{id}/start

Start an ImportJob immediately

POST

/tests

Trigger a new contract test

GET

/tests/{id}

Retrieve a TestResult

POST

/artifact/upload

Upload an artefact directly

POST

/import

Import a Microcks snapshot

GET

/export

Export a Microcks snapshot

GET

/services

List Services and APIs registered in Microcks

POST

/jobs

Create an ImportJob

PUT

/jobs/{id}/start

Start an ImportJob immediately

POST

/tests

Trigger a new contract test

GET

/tests/{id}

Retrieve a TestResult

POST

Why Jentic?

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

Credential isolation

Microcks JWTs from Keycloak are stored encrypted in the Jentic vault. Agents request operations and Jentic injects the Authorization header at execution time, so the token never appears in the agent's context.

Intent-based discovery

Agents search Jentic with intents like 'run a contract test' or 'create an import job' and Jentic returns the matching Microcks operation with its parameter schema, so the agent does not navigate the 44-endpoint admin API by hand.

Time to first call

Direct Microcks integration: 1-2 days to wire Keycloak, ImportJobs, and TestResults polling. Through Jentic: under 1 hour for the common import and test flows.

FAQs

Specific to using Microcks API v1.7 API through Jentic.

What authentication does the Microcks API use?

Microcks accepts OAuth 2.0 JWT tokens issued by its bundled Keycloak instance, configured via the GET /keycloak/config endpoint. Through Jentic the JWT is stored in the encrypted vault and added to the Authorization header at execution time.

Can I import a Postman collection as a service?

Yes — POST /artifact/upload accepts Postman collections alongside OpenAPI and AsyncAPI artefacts. For repeatable imports use POST /jobs with the artefact URL so Microcks pulls and refreshes it on a schedule.

What are the rate limits for the Microcks API?

Microcks itself does not enforce documented per-endpoint rate limits — limits are governed by the deployment topology and the Keycloak token policy. For high-frequency CI integrations, batch service queries through /services/search and reuse tokens.

How do I trigger a contract test through Jentic?

Search Jentic for 'run a Microcks test', load POST /tests, and submit the service ID, target endpoint, and runner type. Jentic adds the JWT from your stored credential and the agent polls GET /tests/{id} for completion.

Is Microcks free to use?

Yes — Microcks is open-source under Apache 2.0 and you self-host it. The API is part of the open-source distribution; commercial support is available from the Microcks team but is not required to use the API.

Can I override individual mock operations without re-importing?

Yes — PUT /services/{id}/operation lets you tweak a single operation's settings, and PUT /services/{id}/metadata updates labels and metadata without re-running the import job.

Microcks API v1.7

Connect the Microcks API v1.7 to your agent

Capabilities

Start building with Microcks API v1.7 API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs