How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Microcks job API

Operations related to Jobs for discovering mocks and tests

Microcks job API is one of 6 APIs that Microcks publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Job. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.

This API exposes 11 operations across 8 paths, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version 1.14.0.

Requests are made against a single base URL, http://microcks.example.com/api.

11 operations 8 paths 7 schemas 1 DELETE3 GET4 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.14.0
Server
http://microcks.example.com/api
Authentication
OAuth 2.0
License
Resource Areas
1

Authentication & Security 1

Microcks job API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (jwt-bearer) using the clientCredentials flow, exposing 3 scopes. By default, every request must be authenticated.

  • jwt-bearer — JWT Bearer acquired using OAuth 2 Authentication flow or Direct Access Grant

Paths & Operations 11

Across 8 paths, the API surfaces 11 operations — 1 DELETE, 3 GET, 4 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

job 11

Operations related to Jobs for discovering mocks and tests

GET
/jobs
Get ImportJobs
GetImportJobs 3 params → 200
POST
/jobs
Create ImportJob
CreateImportJob body → 201
GET
/jobs/{id}
Get ImportJob
GetImportJob 1 param → 200
POST
/jobs/{id}
Update ImportJob
UpdateImportJob 1 param body → 200
DELETE
/jobs/{id}
Delete ImportJob
DeleteImportJob 1 param → 200
GET
/jobs/count
Get the ImportJobs counter
GetImportJobCounter → 200
PUT
/jobs/{id}/start
Start an ImportJob
StartImportJob 1 param → 200
PUT
/jobs/{id}/stop
Stop an ImportJob
StopImportJob 1 param → 200
PUT
/jobs/{id}/activate
Activate an ImportJob
ActivateImportJob 1 param → 200
POST
/artifact/download
Download an artifact
downloadArtifact body → 201204400
POST
/artifact/upload
Upload an artifact
uploadArtifact 1 param body → 201204400

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are ImportJob (14 properties), Metadata (4 properties), ArtifactDownload (3 properties), ServiceRef (3 properties). Each schema is shown below with its type and property counts.

Metadata
object
Commodity object for holding metadata on any entity. This object is inspired by Kubernetes metadata.
4 properties 2 required
ServiceRef
object
Lightweight reference of an existing Service
3 properties 3 required
ArtifactUpload
object
Artifact to be imported by Microcks. This structure represents a mime-multipart file upload (as specified here: https://swagger.io/docs/specification/describin…
1 property 1 required
ImportJob
object
An ImportJob allow defining a repository artifact to poll for discovering Services and APIs mocks and tests
14 properties 2 required
SecretRef
object
Lightweight reference for an existing Secret
2 properties 2 required
ArtifactDownload
object
Artifact Download specification to be imported by Microcks.
3 properties 1 required
Counter
object
A simple Counter type.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microcks-job-api-openapi.yml Raw ↑

Other APIs Microcks publishes across the network.

Microcks config API
Microcks metrics API
Microcks mock API
Microcks Resources API
Microcks test API
Where this information came from

This is an independent, third-party profile of Microcks job API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.