JFrog Deployments API

openapi: 3.1.0
info:
  title: JFrog Access REST Access Tokens Deployments API
  description: API for managing users, groups, permissions, projects, and access tokens across the JFrog Platform. JFrog Access handles identity management, role-based access control, federated identity, and scoped token creation for authentication and authorization across all JFrog services.
  version: 2.x
  contact:
    name: JFrog
    url: https://jfrog.com
  license:
    name: Proprietary
    url: https://jfrog.com/terms-of-service/
  termsOfService: https://jfrog.com/terms-of-service/
servers:
- url: https://{server}.jfrog.io/access
  description: JFrog Cloud
  variables:
    server:
      default: myserver
      description: Your JFrog server name
- url: https://{host}/access
  description: Self-hosted JFrog instance
  variables:
    host:
      default: localhost:8082
      description: Your self-hosted JFrog server host
security:
- bearerAuth: []
- basicAuth: []
tags:
- name: Deployments
  description: Model deployment and serving
paths:
  /v1/deployments:
    get:
      operationId: listDeployments
      summary: JFrog List Deployments
      description: Returns a list of all model deployments.
      tags:
      - Deployments
      responses:
        '200':
          description: Deployments list
          content:
            application/json:
              schema:
                type: object
                properties:
                  deployments:
                    type: array
                    items:
                      $ref: '#/components/schemas/Deployment'
    post:
      operationId: createDeployment
      summary: JFrog Create Deployment
      description: Deploys a model version for serving predictions.
      tags:
      - Deployments
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeploymentRequest'
      responses:
        '201':
          description: Deployment created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Deployment'
  /v1/deployments/{deploymentId}:
    get:
      operationId: getDeployment
      summary: JFrog Get Deployment
      description: Returns details for a specific deployment.
      tags:
      - Deployments
      parameters:
      - name: deploymentId
        in: path
        required: true
        schema:
          type: string
        description: Deployment ID
      responses:
        '200':
          description: Deployment details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Deployment'
    delete:
      operationId: deleteDeployment
      summary: JFrog Delete Deployment
      description: Removes a model deployment.
      tags:
      - Deployments
      parameters:
      - name: deploymentId
        in: path
        required: true
        schema:
          type: string
        description: Deployment ID
      responses:
        '204':
          description: Deployment deleted
components:
  schemas:
    Deployment:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        model_id:
          type: string
        model_version_id:
          type: string
        status:
          type: string
          enum:
          - deploying
          - active
          - stopped
          - failed
        endpoint_url:
          type: string
          format: uri
        replicas:
          type: integer
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    DeploymentRequest:
      type: object
      properties:
        name:
          type: string
        model_id:
          type: string
        model_version_id:
          type: string
        replicas:
          type: integer
          default: 1
        resources:
          type: object
          properties:
            cpu:
              type: string
            memory:
              type: string
            gpu:
              type: integer
      required:
      - name
      - model_id
      - model_version_id
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Access token authentication
    basicAuth:
      type: http
      scheme: basic
      description: Basic username/password authentication
externalDocs:
  description: JFrog Access REST API Documentation
  url: https://jfrog.com/help/r/jfrog-platform-administration-documentation/access-token-rest-api