Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

JFrog Workers API

Worker lifecycle management

JFrog Workers API is one of 53 APIs that JFrog publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Workers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a getting-started guide, an API reference, and an engineering blog.

This API exposes 7 operations across 4 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 2.x.

Requests are made against 2 base URLs: https://{server}.jfrog.io/access, https://{host}/access.

7 operations 4 paths 2 schemas 1 DELETE2 GET1 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.x
Base URL
https://myserver.jfrog.io/artifactory/api
Authentication
HTTP Bearer, HTTP Basic
Contact
Terms of Service
Resource Areas
1

Authentication & Security 2

JFrog Workers API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • bearerAuth — Access token authentication
  • basicAuth — Basic username/password authentication

Paths & Operations 7

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

Workers 7

Worker lifecycle management

GET
/v1/workers
JFrog List Workers
listWorkers → 200
POST
/v1/workers
JFrog Create Worker
createWorker body → 201400
GET
/v1/workers/{workerKey}
JFrog Get Worker
getWorker 1 param → 200404
PUT
/v1/workers/{workerKey}
JFrog Update Worker
updateWorker 1 param body → 200
DELETE
/v1/workers/{workerKey}
JFrog Delete Worker
deleteWorker 1 param → 204
PUT
/v1/workers/{workerKey}/enable
JFrog Enable Worker
enableWorker 1 param → 200
PUT
/v1/workers/{workerKey}/disable
JFrog Disable Worker
disableWorker 1 param → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Worker (9 properties), WorkerRequest (7 properties). Each schema is shown below with its type and property counts.

WorkerRequest
object
7 properties 3 required
Worker
object
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jfrog-workers-api-openapi.yml Raw ↑

Other APIs JFrog publishes across the network.

JFrog Access Tokens API
JFrog Artifacts & Storage API
JFrog Audit API
JFrog Builds API
JFrog Commands API
JFrog Components API
JFrog Deployments API
JFrog Device Groups API
JFrog Devices API
JFrog Distribution API
JFrog Evidence API
JFrog Execution API