Use API Endpoints via CLI

Use the jf api command to invoke any JFrog Platform HTTP API directly from the JFrog CLI using your configured server URL and credentials.

The CLI automatically uses the configured hostname and authentication from jf config, or you can override them with --url, --access-token, or --server-id.

Use jf api with all JFrog Platform APIs, including:

• Platform Administration
• Binary Management (Artifactory)
• Security
• Governance (AppTrust)
• Integrations
• Project Management

Benefits of JF API

jf api provides:

• Unified access to all JFrog APIs from one CLI command
• Reuse of existing CLI authentication and configuration
• Easier scripting and automation
• Direct GraphQL and REST API access
• Faster experimentation without a separate curl authentication setup

Prerequisites

To use jf api, verify the following:

• JFrog CLI installed, version 2.100.0 or later
• At least one server configured with jf config add, or --url and credentials passed inline

Synopsis

jf api <endpoint-path>

Aliases: none

Arguments

The following table lists command arguments.

Options

The following table lists command options.

Examples

Access REST APIs

List Users

To list all users in Access:

Request:

jf api /access/api/v2/users

Response:

{
  "users": [
    {
      "username": "admin",
      "realm": "internal",
      "status": "enabled",
      "uri": "/access/api/v2/users/admin"
    }
  ]
}

Get a User by Name

To get details for a single user:

Request:

jf api /access/api/v2/users/admin

Response:

{
  "username": "admin",
  "email": "[email protected]",
  "admin": true,
  "effective_admin": true,
  "profile_updatable": true,
  "disable_ui_access": false,
  "internal_password_disabled": false,
  "last_logged_in": "2024-07-17T13:43:28.608Z",
  "password_expired": false,
  "password_last_modified": "2023-07-04T14:14:46.064Z",
  "realm": "internal",
  "groups": [
    "readers"
  ],
  "status": "enabled",
  "policy_viewer": true,
  "watch_manager": true,
  "reports_manager": true,
  "policy_manager": true,
  "resources_manager": true,
  "manage_webhook": false,
  "platform_auditor": false
}

Create a User

To create a user from a JSON file:

1. Create a user.json file with the user definition:

   JSON

   {
     "username": "newuser",
     "email": "[email protected]",
     "password": "UseASecurePassword123",
     "admin": false,
     "groups": ["readers"]
   }

2. Run:

   Bash

   jf api /access/api/v2/users \
     -X POST \
     --input ./user.json \
     -H "Content-Type: application/json"

To create a user with an inline JSON body:

jf api /access/api/v2/users \
  -X POST \
  -d '{"username":"newuser","email":"[email protected]","password":"UseASecurePassword123"}' \
  -H "Content-Type: application/json"

📘

Note

The --data and --input command options are mutually exclusive.

Replace a User

To replace an existing user with a new definition:

jf api /access/api/v2/users/newuser \
  -X PUT \
  --input ./user.json \
  -H "Content-Type: application/json"

Delete a User

To delete a user:

jf api -X DELETE /access/api/v2/users/tempuser

Artifactory APIs

List Repositories

To list all repositories in Artifactory:

jf api /artifactory/api/repositories

Create a Local Maven Repository

To create a local Maven repository:

jf api /artifactory/api/repositories/my-maven-local \
  -X PUT \
  --input ./repo-maven-local.json \
  -H "Content-Type: application/json"

Update Repository Configuration

To update an existing repository's configuration:

jf api /artifactory/api/repositories/libs-release \
  -X POST \
  --input ./repo-config.json \
  -H "Content-Type: application/json"

Delete a Repository

To delete a repository:

jf api /artifactory/api/repositories/old-repo -X DELETE

Set a Request Timeout

To set a request timeout in seconds:

jf api /artifactory/api/repositories --timeout 10

OneModel GraphQL

To run a GraphQL query through OneModel:

jf api /onemodel/api/v1/graphql \
  -X POST \
  --input ./graphql-query.json \
  -H "Content-Type: application/json"

Use a Specific Server

To target a non-default configured server:

jf api /access/api/v2/users --server-id=my-server

Common Errors

The following table lists common errors, causes, and resolutions.

See Also

For more information, see:

• Add a server configuration with jf config add
• Authenticate with the JFrog CLI