Microcks API v1.7 API

by microcks.local

Overview

API offered by Microcks, the Kuebrnetes native tools for API and microservices mocking and testing (microcks.io)

Microcks API v1.7 is a development API from microcks.local. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 44 endpoints.

At a glance

Authentication: OAuth
HTTPS: Yes
CORS: Unknown
Category: Development
Base URL: http://microcks.local
Version: 1.7.0
Endpoints: 44
OpenAPI: Specification ↗
Spec updated: 2023-04-05

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL

curl -X GET "http://microcks.local/export" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"

JavaScript

const response = await fetch("http://microcks.local/export", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "GET",
    "http://microcks.local/export",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

Method	Path	What it does
POST	`/artifact/upload`	Upload an artifact
GET	`/export`	Export a snapshot
GET	`/features/config`	Get features configuration
POST	`/import`	Import a snapshot
GET	`/jobs`	Get ImportJobs
POST	`/jobs`	Create ImportJob
GET	`/jobs/count`	Get the ImportJobs counter
GET	`/jobs/{id}`	Get ImportJob
POST	`/jobs/{id}`	Update ImportJob
DELETE	`/jobs/{id}`	Delete ImportJob
PUT	`/jobs/{id}/activate`	Activate an ImportJob
PUT	`/jobs/{id}/start`	Start an ImportJob
PUT	`/jobs/{id}/stop`	Stop an ImportJob
GET	`/keycloak/config`	Get authentification configuration
GET	`/metrics/conformance/aggregate`	Get aggregation of conformance metrics
GET	`/metrics/conformance/service/{serviceId}`	Get conformance metrics for a Service
GET	`/metrics/invocations/global`	Get aggregated invocation statistics for a day
GET	`/metrics/invocations/global/latest`	Get aggregated invocations statistics for latest days
GET	`/metrics/invocations/top`	Get top invocation statistics for a day
GET	`/metrics/invocations/{serviceName}/{serviceVersion}`	Get invocation statistics for Service
GET	`/metrics/tests/latest`	Get latest tests results
GET	`/resources/service/{serviceId}`	Get Resources by Service
GET	`/resources/{name}`	Get Resource
GET	`/secrets`	Get Secrets
POST	`/secrets`	Create a new Secret
GET	`/secrets/count`	Get the Secrets counter
GET	`/secrets/{id}`	Get Secret
PUT	`/secrets/{id}`	Update Secret
DELETE	`/secrets/{id}`	Delete Secret
GET	`/services`	Get Services and APIs
GET	`/services/count`	Get the Services counter
GET	`/services/labels`	Get the already used labels for Services
GET	`/services/search`	Search for Services and APIs
GET	`/services/{id}`	Get Service
DELETE	`/services/{id}`	Delete Service
PUT	`/services/{id}/metadata`	Update Service Metadata
PUT	`/services/{id}/operation`	Override Service Operation
POST	`/tests`	Create a new Test
GET	`/tests/service/{serviceId}`	Get TestResults by Service
GET	`/tests/service/{serviceId}/count`	Get the TestResults for Service counter
GET	`/tests/{id}`	Get TestResult
GET	`/tests/{id}/events/{testCaseId}`	Get events for TestCase
GET	`/tests/{id}/messages/{testCaseId}`	Get messages for TestCase
POST	`/tests/{id}/testCaseResult`	Report and create a new TestCaseResult