JFrog Node Pools API

openapi: 3.1.0
info:
  title: JFrog Access REST Access Tokens Node Pools 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: Node Pools
  description: Build node pool management
paths:
  /v1/nodePools:
    get:
      operationId: listNodePools
      summary: JFrog List Node Pools
      description: Returns a list of all build node pools.
      tags:
      - Node Pools
      responses:
        '200':
          description: Node pools list
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/NodePool'
    post:
      operationId: createNodePool
      summary: JFrog Create Node Pool
      description: Creates a new build node pool.
      tags:
      - Node Pools
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NodePoolRequest'
      responses:
        '200':
          description: Node pool created
  /v1/nodePools/{nodePoolId}:
    get:
      operationId: getNodePool
      summary: JFrog Get Node Pool
      description: Returns details for a specific node pool.
      tags:
      - Node Pools
      parameters:
      - name: nodePoolId
        in: path
        required: true
        schema:
          type: integer
        description: Node pool ID
      responses:
        '200':
          description: Node pool details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NodePool'
    delete:
      operationId: deleteNodePool
      summary: JFrog Delete Node Pool
      description: Deletes a node pool.
      tags:
      - Node Pools
      parameters:
      - name: nodePoolId
        in: path
        required: true
        schema:
          type: integer
        description: Node pool ID
      responses:
        '200':
          description: Node pool deleted
components:
  schemas:
    NodePoolRequest:
      type: object
      properties:
        name:
          type: string
        projectId:
          type: integer
        numberOfNodes:
          type: integer
        isOnDemand:
          type: boolean
        architecture:
          type: string
        operatingSystem:
          type: string
      required:
      - name
    NodePool:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        projectId:
          type: integer
        numberOfNodes:
          type: integer
        isOnDemand:
          type: boolean
        architecture:
          type: string
        operatingSystem:
          type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
  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