Microcks API v1.7
API offered by Microcks, the Kuebrnetes native tools for API and microservices mocking and testing (microcks.io)
Developer tools#openapi#developer-tools
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
API offered by Microcks, the Kuebrnetes native tools for API and microservices mocking and testing (microcks.io)
Endpoints 44
mock
- GETExport a snapshot
/export?serviceIds=stringExport a repostiory snapshot with requested services - POSTImport a snapshot
/importImport a repository snapshot previsouly exported into Microcks - GETGet Services and APIs
/services?page=0&size=0 - GETGet the Services counter
/services/count - GETGet the already used labels for Services
/services/labels - GETSearch for Services and APIs
/services/search?queryMap={"additionalProp1":"string"} - GETGet Service
/services/:id?messages=true - DELETEDelete Service
/services/:idDelete a Service - PUTUpdate Service Metadata
/services/:id/metadata - PUTOverride Service Operation
/services/:id/operation?operationName=string
test
- POSTCreate a new Test
/tests - GETGet TestResults by Service
/tests/service/:serviceId - GETGet the TestResults for Service counter
/tests/service/:serviceId/count - GETGet TestResult
/tests/:id - GETGet events for TestCase
/tests/:id/events/:testCaseId - GETGet messages for TestCase
/tests/:id/messages/:testCaseId - POSTReport and create a new TestCaseResult
/tests/:id/testCaseResultReport a TestCaseResult (typically used by a Test runner)
job
- POSTUpload an artifact
/artifact/upload?mainArtifact=trueUploads an artifact to be imported by Microcks. - GETGet ImportJobs
/jobs?page=0&size=0&name=stringRetrieve a list of ImportJobs - POSTCreate ImportJob
/jobsCreate a new ImportJob - GETGet the ImportJobs counter
/jobs/count - GETGet ImportJob
/jobs/:idRetrieve an ImportJob using its identifier - POSTUpdate ImportJob
/jobs/:idUpdate an ImportJob - DELETEDelete ImportJob
/jobs/:idDelete an ImportJob - PUTActivate an ImportJob
/jobs/:id/activateMake an ImportJob active, so that it is executed - PUTStart an ImportJob
/jobs/:id/startStarting an ImportJob forces it to immediatly import mock definitions - PUTStop an ImportJob
/jobs/:id/stopStopping an ImportJob desactivate it, so that it won't execute at next schedule
config
- GETGet features configuration
/features/config - GETGet authentification configuration
/keycloak/config - GETGet Secrets
/secrets?page=0&size=0 - POSTCreate a new Secret
/secrets - GETGet the Secrets counter
/secrets/count - GETGet Secret
/secrets/:idRetrieve a Secret - PUTUpdate Secret
/secrets/:idUpdate a Secret - DELETEDelete Secret
/secrets/:idDelete a Secret
metrics
- GETGet aggregation of conformance metrics
/metrics/conformance/aggregate - GETGet conformance metrics for a Service
/metrics/conformance/service/:serviceId - GETGet aggregated invocation statistics for a day
/metrics/invocations/global?day=string - GETGet aggregated invocations statistics for latest days
/metrics/invocations/global/latest?limit=0 - GETGet top invocation statistics for a day
/metrics/invocations/top?day=string&limit=0 - GETGet invocation statistics for Service
/metrics/invocations/:serviceName/:serviceVersion?day=string - GETGet latest tests results
/metrics/tests/latest?limit=0
- GETGet Resources by Service
/resources/service/:serviceId - GETGet Resource
/resources/:name
API details
- Base URL
http://microcks.localhttp://microcks.example.com/api- Authentication
- OAuth 2.0 (client credentials flow) with 3 scopes
- Operations
- 44 operations on 37 pathsGET 28POST 7PUT 6DELETE 3
- Main resources
- job 10mock 10config 8metrics 7test 7
- Response formats
application/jsontext/plain- Description format
- OpenAPI 3.0.2, API version
1.7.0 - Links
- OpenAPI document · Support
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Microcks API v1.7 in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Microcks API v1.7 collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (client credentials flow) with 3 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Export a snapshot” (GET /export?serviceIds=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Microcks API v1.7?
API offered by Microcks, the Kuebrnetes native tools for API and microservices mocking and testing (microcks.io) It is listed under Developer tools and has 44 endpoints.
Who publishes the Microcks API v1.7?
It is listed from Microcks's public API description (an OpenAPI document), not published by Microcks on Swastik Codes. Anyone who controls microcks.io can claim the profile by adding a DNS TXT record.
What is the base URL of the Microcks API v1.7?
Its description lists 2 base URLs: http://microcks.local, http://microcks.example.com/api. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Microcks API v1.7?
With OAuth 2.0 (client credentials flow) with 3 scopes.
How many endpoints does the Microcks API v1.7 have?
44 operations on 37 paths (28 GET, 7 POST, 6 PUT, 3 DELETE). The largest groups are job, mock, config, metrics.
Is forking the Microcks API v1.7 free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.