Microcks API v1.7
Microcks API v1.7 exposes REST endpoints for managing mock service definitions, artifacts, import/export snapshots, secrets, and service metadata, as well as for retrieving operational metrics, test results, and related resources such as conformance and invocation statistics.
Latency
714ms p95
Uptime
87.5% 30d
Playground
Verified
live
Endpoints
/artifact/upload
Upload an artifact
/export
Export a snapshot
/features/config
Get features configuration
/import
Import a snapshot
/jobs
Get ImportJobs
/jobs
Create ImportJob
/jobs/count
Get the ImportJobs counter
/jobs/{id}
Delete ImportJob
/jobs/{id}
Get ImportJob
/jobs/{id}
Update ImportJob
/jobs/{id}/activate
Activate an ImportJob
/jobs/{id}/start
Start an ImportJob
/jobs/{id}/stop
Stop an ImportJob
/keycloak/config
Get authentification configuration
/metrics/conformance/aggregate
Get aggregation of conformance metrics
/metrics/conformance/service/{serviceId}
Get conformance metrics for a Service
/metrics/invocations/global
Get aggregated invocation statistics for a day
/metrics/invocations/global/latest
Get aggregated invocations statistics for latest days
/metrics/invocations/top
Get top invocation statistics for a day
/metrics/invocations/{serviceName}/{serviceVersion}
Get invocation statistics for Service
/metrics/tests/latest
Get latest tests results
/resources/service/{serviceId}
Get Resources by Service
/resources/{name}
Get Resource
/secrets
Get Secrets
/secrets
Create a new Secret
/secrets/count
Get the Secrets counter
/secrets/{id}
Delete Secret
/secrets/{id}
Get Secret
/secrets/{id}
Update Secret
/services
Get Services and APIs
/services/count
Get the Services counter
/services/labels
Get the already used labels for Services
/services/search
Search for Services and APIs
/services/{id}
Delete Service
/services/{id}
Get Service
/services/{id}/metadata
Update Service Metadata
/services/{id}/operation
Override Service Operation
/tests
Create a new Test
/tests/service/{serviceId}
Get TestResults by Service
/tests/service/{serviceId}/count
Get the TestResults for Service counter
/tests/{id}
Get TestResult
/tests/{id}/events/{testCaseId}
Get events for TestCase
/tests/{id}/messages/{testCaseId}
Get messages for TestCase
/tests/{id}/testCaseResult
Report and create a new TestCaseResult
44 endpoints auto-detected
Authentication
This API requires authentication: OAuth.
curl -X POST \ "http://microcks.local/artifact/upload"
microcks.local · HTTPS only