Delinea ServerNodes API

openapi: 3.0.0
info:
  title: Secret Server Rest Activations ServerNodes API
  description: REST API documentation for Secret Server. This document describes how to use the REST API. All requests require an authentication token; please see the <a href="../OAuth/">authentication document</a> for more information. The <a href="swagger.json">Swagger specification</a> for this API is also available.
  termsOfService: https://delinea.com/eula
  contact:
    name: Support
    url: https://delinea.com
  version: 11.7.2
servers:
- url: /SecretServer/api
security:
- BearerToken: []
tags:
- name: ServerNodes
  description: View nodes and update roles or readonly mode
paths:
  /v1/nodes:
    get:
      tags:
      - ServerNodes
      summary: Get Server Nodes
      description: Get Server Nodes
      operationId: ServerNodesService_GetList
      responses:
        '200':
          description: Server Node List
          content:
            application/json:
              schema:
                description: Server Node List
                items:
                  $ref: '#/components/schemas/ServerNodeModel'
                type: array
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
        '403':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationFailedResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
      deprecated: false
  /v1/nodes/{nodeId}:
    get:
      tags:
      - ServerNodes
      summary: Get Server Node
      description: Get Server Node
      operationId: ServerNodesService_Get
      parameters:
      - name: nodeId
        in: path
        description: nodeId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Server Node List
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerNodeModel'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
        '403':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationFailedResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
      deprecated: false
  /v1/nodes/{nodeId}/configuration:
    post:
      tags:
      - ServerNodes
      summary: Update Server Node Configuration
      description: Update Server Node Configuration
      operationId: ServerNodesService_UpdateNodeConfiguration
      parameters:
      - name: nodeId
        in: path
        description: nodeId
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServerNodeConfigurationModel'
        description: nodeConfiguration
      responses:
        '200':
          description: Unknown or empty response
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
        '403':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationFailedResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
      deprecated: false
components:
  schemas:
    BadRequestResponse:
      description: Response object for invalid requests
      required:
      - message
      properties:
        message:
          description: Error message
          type: string
        messageDetail:
          description: Error message detail
          type: string
        errorCode:
          description: Error message code
          type: string
        modelState:
          description: An object describing validation errors
          type: object
      type: object
    ServerNodeConfigurationModel:
      description: Server Node Roles
      properties:
        enableBackgroundWorker:
          description: Background Worker Role Enabled
          type: boolean
        enableEngineWorker:
          description: Engine Worker Role Enabled
          type: boolean
        enableSessionRecordingWorker:
          description: Session Recording Worker Role Enabled
          type: boolean
        inCluster:
          description: Whether or not the node is in the cluster
          type: boolean
        logLevel:
          description: Log Level
          type: string
          nullable: true
        readonlyModeEnabled:
          description: Readonly Mode Enabled
          type: boolean
      type: object
    AuthenticationFailedResponse:
      description: Response object for authentication failures
      required:
      - message
      properties:
        message:
          description: Error message
          type: string
      type: object
    InternalServerErrorResponse:
      description: Response object for internal server errors
      required:
      - message
      - exceptionMessage
      - exceptionType
      - stackTrace
      properties:
        message:
          description: Error message
          type: string
        exceptionMessage:
          description: Error message from exception
          type: string
        exceptionType:
          description: Exception type
          type: string
        stackTrace:
          description: Exception stack trace
          type: string
      type: object
    ServerNodeModel:
      description: ServerNodeModel[]
      properties:
        backgroundWorkerError:
          description: Background Worker Error
          type: string
        binaryVersion:
          description: Binary Version
          type: string
        database:
          description: Database
          type: string
        enableBackgroundWorker:
          description: Background Worker Role Enabled
          type: boolean
          nullable: true
        enableEngineWorker:
          description: Engine Worker Role Enabled
          type: boolean
          nullable: true
        enableSessionRecordingWorker:
          description: Session Recording Worker Role Enabled
          type: boolean
          nullable: true
        engineWorkerError:
          description: Engine Worker Error
          type: string
        errorMessage:
          description: The node configuration error if one exists
          type: string
        inCluster:
          description: In Cluster
          type: boolean
        isCurrentNode:
          description: Whether or not this node is the one which handled the request
          type: boolean
        lastConnected:
          description: The date of the last time the node connected
          type: string
        logLevel:
          description: Log Level
          type: string
          nullable: true
        machineName:
          description: Machine Name
          type: string
        nodeId:
          description: Node Id
          type: integer
          format: int32
        readonlyModeEnabled:
          description: Readonly Mode Enabled
          type: boolean
        readonlyModeStatus:
          description: The status of readonly mode if it is being disabled or enabled
          type: string
        sessionRecordingWorkerError:
          description: Session Recording Worker Error
          type: string
      type: object
  securitySchemes:
    BearerToken:
      type: apiKey
      description: 'Perform a POST request to `/oauth2/token`. It should include three form data parameters - `username`, `password`, and `grant_type`.The `grant_type` parameter should always have the value `password`.The access token returned should be included in the header of subsequent requests, like ''Authorization: Bearer <em>token</em>''. The token remains valid for a time period returned in the ''expires_in'' property (in seconds). For details, see the <a href="../OAuth/">token request documentation</a>.'
      name: Authorization
      in: header