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 Deployments API

Model deployment and serving

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

Tagged areas include Deployments. 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 4 operations across 2 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.

4 operations 2 paths 2 schemas 1 DELETE2 GET1 POST

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 Deployments 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 4

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

Deployments 4

Model deployment and serving

GET
/v1/deployments
JFrog List Deployments
listDeployments → 200
POST
/v1/deployments
JFrog Create Deployment
createDeployment body → 201
GET
/v1/deployments/{deploymentId}
JFrog Get Deployment
getDeployment 1 param → 200
DELETE
/v1/deployments/{deploymentId}
JFrog Delete Deployment
deleteDeployment 1 param → 204

Schemas 2

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

Deployment
object
9 properties
DeploymentRequest
object
5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jfrog-deployments-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 Device Groups API
JFrog Devices API
JFrog Distribution API
JFrog Evidence API
JFrog Execution API
JFrog Experiments API