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

Remote execution scripts

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

Tagged areas include Scripts. 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 3 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.

3 operations 2 paths 2 schemas 1 GET2 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 Scripts 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 3

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

Scripts 3

Remote execution scripts

GET
/v1/scripts
JFrog List Scripts
listScripts → 200
POST
/v1/scripts
JFrog Create Script
createScript body → 201
POST
/v1/scripts/{scriptName}/execute
JFrog Execute Script
executeScript 1 param body → 200

Schemas 2

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

ScriptRequest
object
3 properties 2 required
Script
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jfrog-scripts-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