@itentialopensource/adapter-nexus_repository/report/adapter-openapi.yaml

This adapter integrates with system described as: nexusRepositoryManagerRestApi.

openapi: 3.0.0
info:
  title: Nexus Repository Manager REST API
  contact: {}
  version: '3.21.2-03'
servers:
- url: https://{defaultHost}
  variables:
    defaultHost:
      default: www.example.com/service/rest/
paths:
  /beta/security/user-sources:
    get:
      tags:
      - Security Management
      summary: getUserSources
      description: Retrieve a list of the available user sources.
      operationId: getUserSources
      parameters: []
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiUserSource'
                description: ''
        '403':
          description: The user does not have permission to perform the operation.
          headers: {}
          content: {}
      deprecated: false
  /beta/security/users/{userId}:
    put:
      tags:
      - 'Security Management: Users'
      summary: updateUser
      description: Update an existing user.
      operationId: updateUser
      parameters:
      - name: userId
        in: path
        description: The userid the request should apply to.
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: A representation of the user to update.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ApiUser'
              - description: A representation of the user to update.
        required: false
      responses:
        '400':
          description: Password was not supplied in the body of the request
          headers: {}
          content: {}
        '403':
          description: The user does not have permission to perform the operation.
          headers: {}
          content: {}
        '404':
          description: User or user source not found in the system.
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - 'Security Management: Users'
      summary: deleteUser
      description: Delete a user.
      operationId: deleteUser
      parameters:
      - name: userId
        in: path
        description: The userid the request should apply to.
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '400':
          description: Password was not supplied in the body of the request
          headers: {}
          content: {}
        '403':
          description: The user does not have permission to perform the operation.
          headers: {}
          content: {}
        '404':
          description: User or user source not found in the system.
          headers: {}
          content: {}
      deprecated: false
  /beta/security/users:
    get:
      tags:
      - 'Security Management: Users'
      summary: getUsers
      description: Retrieve a list of users. Note if the source is not 'default' the response is limited to 100 users.
      operationId: getUsers
      parameters:
      - name: userId
        in: query
        description: An optional term to search userids for.
        style: form
        explode: true
        schema:
          type: string
      - name: source
        in: query
        description: An optional user source to restrict the search to.
        style: form
        explode: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiUser'
                description: ''
        '400':
          description: Password was not supplied in the body of the request
          headers: {}
          content: {}
        '403':
          description: The user does not have permission to perform the operation.
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - 'Security Management: Users'
      summary: createUser
      description: Create a new user in the default source.
      operationId: createUser
      parameters: []
      requestBody:
        description: A representation of the user to create.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ApiCreateUser'
              - description: A representation of the user to create.
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiUser'
        '400':
          description: Password was not supplied in the body of the request
          headers: {}
          content: {}
        '403':
          description: The user does not have permission to perform the operation.
          headers: {}
          content: {}
      deprecated: false
  /beta/security/users/{userId}/change-password:
    put:
      tags:
      - 'Security Management: Users'
      summary: changePassword
      description: Change a user's password.
      operationId: changePassword
      parameters:
      - name: userId
        in: path
        description: The userid the request should apply to.
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The new password to use.
        content:
          text/plain:
            schema:
              type: string
              description: The new password to use.
        required: false
      responses:
        '400':
          description: Password was not supplied in the body of the request
          headers: {}
          content: {}
        '403':
          description: The user does not have permission to perform the operation.
          headers: {}
          content: {}
        '404':
          description: User not found in the system.
          headers: {}
          content: {}
      deprecated: false
  /beta/security/privileges:
    get:
      tags:
      - 'Security Management: Privileges'
      summary: getPrivileges
      description: Retrieve a list of privileges.
      operationId: getPrivileges
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiPrivilege'
                description: ''
        '403':
          description: The user does not have permission to perform the operation.
          headers: {}
          content: {}
      deprecated: false
  /beta/security/privileges/{privilegeId}:
    get:
      tags:
      - 'Security Management: Privileges'
      summary: getPrivilege
      description: Retrieve a privilege by id.
      operationId: getPrivilege
      parameters:
      - name: privilegeId
        in: path
        description: The id of the privilege to retrieve.
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiPrivilege'
        '403':
          description: The user does not have permission to perform the operation.
          headers: {}
          content: {}
        '404':
          description: Privilege not found in the system.
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - 'Security Management: Privileges'
      summary: deletePrivilege
      description: Delete a privilege by id.
      operationId: deletePrivilege
      parameters:
      - name: privilegeId
        in: path
        description: The id of the privilege to delete.
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '400':
          description: The privilege is internal and may not be altered.
          headers: {}
          content: {}
        '403':
          description: The user does not have permission to perform the operation.
          headers: {}
          content: {}
        '404':
          description: Privilege not found in the system.
          headers: {}
          content: {}
      deprecated: false
  /beta/security/privileges/wildcard:
    post:
      tags:
      - 'Security Management: Privileges'
      summary: createPrivilege
      description: Create a wildcard type privilege.
      operationId: createPrivilege
      parameters: []
      requestBody:
        description: The privilege to create.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ApiPrivilegeWildcardRequest'
              - description: The privilege to create.
        required: false
      responses:
        '400':
          description: Privilege object not configured properly.
          headers: {}
          content: {}
        '403':
          description: The user does not have permission to perform the operation.
          headers: {}
          content: {}
      deprecated: false
  /beta/security/privileges/application:
    post:
      tags:
      - 'Security Management: Privileges'
      summary: createPrivilege_1
      description: Create an application type privilege.
      operationId: createPrivilege_1
      parameters: []
      requestBody:
        description: The privilege to create.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ApiPrivilegeApplicationRequest'
              - description: The privilege to create.
        required: false
      responses:
        '400':
          description: Privilege object not configured properly.
          headers: {}
          content: {}
        '403':
          description: The user does not have permission to perform the operation.
          headers: {}
          content: {}
      deprecated: false
  /beta/security/privileges/wildcard/{privilegeId}:
    put:
      tags:
      - 'Security Management: Privileges'
      summary: updatePrivilege
      description: Update a wildcard type privilege.
      operationId: updatePrivilege
      parameters:
      - name: privilegeId
        in: path
        description: The id of the privilege to update.
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The privilege to update.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ApiPrivilegeWildcardRequest'
              - description: The privilege to update.
        required: false
      responses:
        '400':
          description: Privilege object not configured properly.
          headers: {}
          content: {}
        '403':
          description: The user does not have permission to perform the operation.
          headers: {}
          content: {}
        '404':
          description: Privilege not found in the system.
          headers: {}
          content: {}
      deprecated: false
  /beta/security/privileges/application/{privilegeId}:
    put:
      tags:
      - 'Security Management: Privileges'
      summary: updatePrivilege_1
      description: Update an application type privilege.
      operationId: updatePrivilege_1
      parameters:
      - name: privilegeId
        in: path
        description: The id of the privilege to update.
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The privilege to update.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ApiPrivilegeApplicationRequest'
              - description: The privilege to update.
        required: false
      responses:
        '400':
          description: Privilege object not configured properly.
          headers: {}
          content: {}
        '403':
          description: The user does not have permission to perform the operation.
          headers: {}
          content: {}
        '404':
          description: Privilege not found in the system.
          headers: {}
          content: {}
      deprecated: false
  /beta/security/privileges/repository-content-selector:
    post:
      tags:
      - 'Security Management: Privileges'
      summary: createPrivilege_2
      description: Create a repository content selector type privilege.
      operationId: createPrivilege_2
      parameters: []
      requestBody:
        description: The privilege to create.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ApiPrivilegeRepositoryContentSelectorRequest'
              - description: The privilege to create.
        required: false
      responses:
        '400':
          description: Privilege object not configured properly.
          headers: {}
          content: {}
        '403':
          description: The user does not have permission to perform the operation.
          headers: {}
          content: {}
      deprecated: false
  /beta/security/privileges/repository-admin:
    post:
      tags:
      - 'Security Management: Privileges'
      summary: createPrivilege_3
      description: Create a repository admin type privilege.
      operationId: createPrivilege_3
      parameters: []
      requestBody:
        description: The privilege to create.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ApiPrivilegeRepositoryAdminRequest'
              - description: The privilege to create.
        required: false
      responses:
        '400':
          description: Privilege object not configured properly.
          headers: {}
          content: {}
        '403':
          description: The user does not have permission to perform the operation.
          headers: {}
          content: {}
      deprecated: false
  /beta/security/privileges/repository-view:
    post:
      tags:
      - 'Security Management: Privileges'
      summary: createPrivilege_4
      description: Create a repository view type privilege.
      operationId: createPrivilege_4
      parameters: []
      requestBody:
        description: The privilege to create.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ApiPrivilegeRepositoryAdminRequest'
              - description: The privilege to create.
        required: false
      responses:
        '400':
          description: Privilege object not configured properly.
          headers: {}
          content: {}
        '403':
          description: The user does not have permission to perform the operation.
          headers: {}
          content: {}
      deprecated: false
  /beta/security/privileges/repository-view/{privilegeId}:
    put:
      tags:
      - 'Security Management: Privileges'
      summary: updatePrivilege_2
      description: Update a repository view type privilege.
      operationId: updatePrivilege_2
      parameters:
      - name: privilegeId
        in: path
        description: The id of the privilege to update.
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The privilege to update.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ApiPrivilegeRepositoryAdminRequest'
              - description: The privilege to update.
        required: false
      responses:
        '400':
          description: Privilege object not configured properly.
          headers: {}
          content: {}
        '403':
          description: The user does not have permission to perform the operation.
          headers: {}
          content: {}
        '404':
          description: Privilege not found in the system.
          headers: {}
          content: {}
      deprecated: false
  /beta/security/privileges/repository-content-selector/{privilegeId}:
    put:
      tags:
      - 'Security Management: Privileges'
      summary: updatePrivilege_3
      description: Update a repository content selector type privilege.
      operationId: updatePrivilege_3
      parameters:
      - name: privilegeId
        in: path
        description: The id of the privilege to update.
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The privilege to update.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ApiPrivilegeRepositoryContentSelectorRequest'
              - description: The privilege to update.
        required: false
      responses:
        '400':
          description: Privilege object not configured properly.
          headers: {}
          content: {}
        '403':
          description: The user does not have permission to perform the operation.
          headers: {}
          content: {}
        '404':
          description: Privilege not found in the system.
          headers: {}
          content: {}
      deprecated: false
  /beta/security/privileges/repository-admin/{privilegeId}:
    put:
      tags:
      - 'Security Management: Privileges'
      summary: updatePrivilege_4
      description: Update a repository admin type privilege.
      operationId: updatePrivilege_4
      parameters:
      - name: privilegeId
        in: path
        description: The id of the privilege to update.
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The privilege to update.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ApiPrivilegeRepositoryAdminRequest'
              - description: The privilege to update.
        required: false
      responses:
        '400':
          description: Privilege object not configured properly.
          headers: {}
          content: {}
        '403':
          description: The user does not have permission to perform the operation.
          headers: {}
          content: {}
        '404':
          description: Privilege not found in the system.
          headers: {}
          content: {}
      deprecated: false
  /beta/security/privileges/script:
    post:
      tags:
      - 'Security Management: Privileges'
      summary: createPrivilege_5
      description: Create a script type privilege.
      operationId: createPrivilege_5
      parameters: []
      requestBody:
        description: The privilege to create.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ApiPrivilegeScriptRequest'
              - description: The privilege to create.
        required: false
      responses:
        '400':
          description: Privilege object not configured properly.
          headers: {}
          content: {}
        '403':
          description: The user does not have permission to perform the operation.
          headers: {}
          content: {}
      deprecated: false
  /beta/security/privileges/script/{privilegeId}:
    put:
      tags:
      - 'Security Management: Privileges'
      summary: updatePrivilege_5
      description: Update a script type privilege.
      operationId: updatePrivilege_5
      parameters:
      - name: privilegeId
        in: path
        description: The id of the privilege to update.
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The privilege to update.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ApiPrivilegeScriptRequest'
              - description: The privilege to update.
        required: false
      responses:
        '400':
          description: Privilege object not configured properly.
          headers: {}
          content: {}
        '403':
          description: The user does not have permission to perform the operation.
          headers: {}
          content: {}
        '404':
          description: Privilege not found in the system.
          headers: {}
          content: {}
      deprecated: false
  /beta/security/realms/available:
    get:
      tags:
      - 'Security Management: Realms'
      summary: getRealms
      description: List the available realms
      operationId: getRealms
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RealmApiXO'
                description: ''
      deprecated: false
  /beta/security/realms/active:
    get:
      tags:
      - 'Security Management: Realms'
      summary: getActiveRealms
      description: List the active realm IDs in order
      operationId: getActiveRealms
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
                description: ''
      deprecated: false
    put:
      tags:
      - 'Security Management: Realms'
      summary: setActiveRealms
      description: Set the active security realms in the order they should be used
      operationId: setActiveRealms
      parameters: []
      requestBody:
        description: The realm IDs
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
              description: The realm IDs
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content: {}
      deprecated: false
  /beta/security/roles:
    get:
      tags:
      - 'Security Management: Roles'
      summary: getRoles
      description: List roles
      operationId: getRoles
      parameters:
      - name: source
        in: query
        description: The id of the user source to filter the roles by, if supplied. Otherwise roles from all user sources will be returned.
        style: form
        explode: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleXOResponse'
                description: ''
        '400':
          description: The specified source does not exist
          headers: {}
          content: {}
        '403':
          description: Insufficient permissions to read roles
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - 'Security Management: Roles'
      summary: create
      description: Create role
      operationId: create
      parameters: []
      requestBody:
        description: A role configuration
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/RoleXORequest'
              - description: A role configuration
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleXOResponse'
        '403':
          description: Insufficient permissions to create role
          headers: {}
          content: {}
      deprecated: false
  /beta/security/roles/{id}:
    get:
      tags:
      - 'Security Management: Roles'
      summary: getRole
      description: Get role
      operationId: getRole
      parameters:
      - name: source
        in: query
        description: The id of the user source to filter the roles by. Available sources can be fetched using the 'User Sources' endpoint.
        style: form
        explode: true
        schema:
          type: string
          default: default
      - name: id
        in: path
        description: The id of the role to get
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleXOResponse'
        '400':
          description: The specified source does not exist
          headers: {}
          content: {}
        '403':
          description: Insufficient permissions to read roles
          headers: {}
          content: {}
        '404':
          description: Role not found
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - 'Security Management: Roles'
      summary: update
      description: Update role
      operationId: update
      parameters:
      - name: id
        in: path
        description: The id of the role to update
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: A role configuration
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/RoleXORequest'
              - description: A role configuration
        required: true
      responses:
        '403':
          description: Insufficient permissions to update role
          headers: {}
          content: {}
        '404':
          description: Role not found
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - 'Security Management: Roles'
      summary: delete
      description: Delete role
      operationId: delete
      parameters:
      - name: id
        in: path
        description: The id of the role to delete
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '403':
          description: Insufficient permissions to delete role
          headers: {}
          content: {}
        '404':
          description: Role not found
          headers: {}
          content: {}
      deprecated: false
  /v1/tasks/{id}:
    get:
      tags:
      - tasks
      summary: getTaskById
      description: Get a single task by id
      operationId: getTaskById
      parameters:
      - name: id
        in: path
        description: Id of the task to get
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskXO'
        '404':
          description: Task not found
          headers: {}
          content: {}
      deprecated: false
  /v1/tasks:
    get:
      tags:
      - tasks
      summary: getTasks
      description: List tasks
      operationId: getTasks
      parameters:
      - name: type
        in: query
        description: Type of the tasks to get
        style: form
        explode: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PageTaskXO'
      deprecated: false
  /v1/tasks/{id}/run:
    post:
      tags:
      - tasks
      summary: run
      description: Run task
      operationId: run
      parameters:
      - name: id
        in: path
        description: Id of the task to run
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '204':
          description: Task was run
          headers: {}
          content: {}
        '404':
          description: Task not found
          headers: {}
          content: {}
        '405':
          description: Task is disabled
          headers: {}
          content: {}
      deprecated: false
  /v1/tasks/{id}/stop:
    post:
      tags:
      - tasks
      summary: stop
      description: Stop task
      operationId: stop
      parameters:
      - name: id
        in: path
        description: Id of the task to stop
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '204':
          description: Task was stopped
          headers: {}
          content: {}
        '404':
          description: Task not found
          headers: {}
          content: {}
        '409':
          description: Unable to stop task
          headers: {}
          content: {}
      deprecated: false
  /beta/blobstores/{name}:
    delete:
      tags:
      - Blob Store
      summary: deleteBlobStore
      description: Delete a blob store by name
      operationId: deleteBlobStore
      parameters:
      - name: name
        in: path
        description: The name of the blob store to delete
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: successful operation
          headers: {}
          content: {}
      deprecated: false
  /beta/blobstores:
    get:
      tags:
      - Blob Store
      summary: listBlobStores
      description: List the blob stores
      operationId: listBlobStores
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GenericBlobStoreApiResponse'
                description: ''
      deprecated: false
  /v1/blobstores/{id}/quota-status:
    get:
      tags:
      - Blob Store
      summary: quotaStatus
      description: Get quota status for a given blob store
      operationId: quotaStatus
      parameters:
      - name: id
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BlobStoreQuotaResultXO'
      deprecated: false
  /beta/blobstores/file:
    post:
      tags:
      - Blob Store
      summary: createFileBlobStore
      description: Create a file blob store
      operationId: createFileBlobStore
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FileBlobStoreApiCreateRequest'
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content: {}
      deprecated: false
  /beta/blobstores/file/{name}:
    get:
      tags:
      - Blob Store
      summary: getFileBlobStoreConfiguration
      description: Get a file blob store configuration by name
      operationId: getFileBlobStoreConfiguration
      parameters:
      - name: name
        in: path
        description: The name of the file blob store to read
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileBlobStoreApiModel'
      deprecated: false
    put:
      tags:
      - Blob Store
      summary: updateFileBlobStore
      description: Update a file blob store configuration by name
      operationId: updateFileBlobStore
      parameters:
      - name: name
        in: path
        description: The name of the file blob store to update
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FileBlobStoreApiUpdateRequest'
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content: {}
      deprecated: false
  /beta/blobstores/s3/{name}:
    get:
      tags:
      - Blob Store
      summary: getBlobStore
      description: Fetch a S3 blob store configuration
      operationId: getBlobStore
      parameters:
      - name: name
        in: path
        description: Name of the blob store configuration to fetch
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
        '400':
          description: Specified S3 blob store doesn't exist
          headers: {}
          content: {}
        '401':
          description: Authentication required
          headers: {}
          content: {}
        '403':
          description: Insufficient permissions
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - Blob Store
      summary: updateBlobStore
      description: Update an S3 blob store configuration
      operationId: updateBlobStore
      parameters:
      - name: name
        in: path
        description: Name of the blob store to update
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/S3BlobStoreApiModel'
        required: false
      responses:
        '204':
          description: S3 blob store updated
          headers: {}
          content: {}
        '400':
          description: Specified S3 blob store doesn't exist
          headers: {}
          content: {}
        '401':
          description: Authentication required
          headers: {}
          content: {}
        '403':
          description: Insufficient permissions
          headers: {}
          content: {}
      deprecated: false
  /beta/blobstores/s3:
    post:
      tags:
      - Blob Store
      summary: createBlobStore
      description: Create an S3 blob store
      operationId: createBlobStore
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/S3BlobStoreApiModel'
        required: false
      responses:
        '201':
          description: S3 blob store created
          headers: {}
          content: {}
        '401':
          description: Authentication required
          headers: {}
          content: {}
        '403':
          description: Insufficient permissions
          headers: {}
          content: {}
      deprecated: false
  /v1/lifecycle/phase:
    get:
      tags:
      - lifecycle
      summary: getPhase
      description: Get current lifecycle phase
      operationId: getPhase
      parameters: []
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
      deprecated: false
    put:
      tags:
      - lifecycle
      summary: setPhase
      description: Move to new lifecycle phase
      operationId: setPhase
      parameters: []
      requestBody:
        description: The phase to move to
        content:
          text/plain:
            schema:
              type: string
              description: The phase to move to
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content: {}
      deprecated: false
  /v1/lifecycle/bounce:
    put:
      tags:
      - lifecycle
      summary: bounce
      description: Re-runs all phases from the given phase to the current phase
      operationId: bounce
      parameters: []
      requestBody:
        description: The phase to bounce
        content:
          text/plain:
            schema:
              type: string
              description: The phase to bounce
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content: {}
      deprecated: false
  /v1/read-only/freeze:
    post:
      tags:
      - read-only
      summary: freeze
      description: Enable read-only
      operationId: freeze
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '204':
          description: System is now read-only
          headers: {}
          content: {}
        '403':
          description: Authentication required
          headers: {}
          content: {}
        '404':
          description: No change to read-only state
          headers: {}
          content: {}
      deprecated: false
  /v1/read-only/force-release:
    post:
      tags:
      - read-only
      summary: forceRelease
      description: 'Forcibly release read-only status, including System initiated tasks. Warning: may result in data loss.'
      operationId: forceRelease
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '204':
          description: System is no longer read-only
          headers: {}
          content: {}
        '403':
          description: Authentication required
          headers: {}
          content: {}
        '404':
          description: No change to read-only state
          headers: {}
          content: {}
      deprecated: false
  /v1/read-only/release:
    post:
      tags:
      - read-only
      summary: release
      description: Release administrator initiated read-only status. Will not release read-only caused by system tasks.
      operationId: release
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '204':
          description: System is no longer read-only
          headers: {}
          content: {}
        '403':
          description: Authentication required
          headers: {}
          content: {}
        '404':
          description: No change to read-only state
          headers: {}
          content: {}
      deprecated: false
  /v1/read-only:
    get:
      tags:
      - read-only
      summary: get
      description: Get read-only state
      operationId: get
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadOnlyState'
      deprecated: false
  /beta/security/ssl/truststore/{id}:
    delete:
      tags:
      - 'Security: Certificates'
      summary: removeCertificate
      description: Remove a certificate in the trust store.
      operationId: removeCertificate
      parameters:
      - name: id
        in: path
        description: The id of the certificate that should be removed.
        required: true
        style: simple
        schema:
          type: string
      responses:
        '403':
          description: Insufficient permissions to remove certificate from the trust store
          headers: {}
          content: {}
      deprecated: false
  /beta/security/ssl/truststore:
    get:
      tags:
      - 'Security: Certificates'
      summary: getTrustStoreCertificates
      description: Retrieve a list of certificates added to the trust store.
      operationId: getTrustStoreCertificates
      parameters: []
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiCertificate'
                description: ''
        '403':
          description: Insufficient permissions to list certificates in the trust store.
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - 'Security: Certificates'
      summary: addCertificate
      description: Add a certificate to the trust store.
      operationId: addCertificate
      parameters: []
      requestBody:
        description: The certificate to add encoded in PEM format
        content:
          text/plain:
            schema:
              type: string
              description: The certificate to add encoded in PEM format
        required: false
      responses:
        '201':
          description: The certificate was successfully added.
          headers: {}
          content:
            application/json:
              schema:
                type: object
        '403':
          description: Insufficient permissions to add certificate to the trust store.
          headers: {}
          content: {}
        '409':
          description: The certificate already exists in the system.
          headers: {}
          content: {}
      deprecated: false
  /beta/security/ssl:
    get:
      tags:
      - 'Security: Certificates'
      summary: retrieveCertificate
      description: Helper method to retrieve certificate details from a remote system.
      operationId: retrieveCertificate
      parameters:
      - name: host
        in: query
        description: The remote system's host name
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: port
        in: query
        description: The port on the remote system to connect to
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 443
      - name: protocolHint
        in: query
        description: An optional hint of the protocol to try for the connection
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiCertificate'
        '400':
          description: A certificate could not be retrieved, see the message for details.
          headers: {}
          content: {}
        '403':
          description: Insufficient permissions to retrieve remote certificate.
          headers: {}
          content: {}
      deprecated: false
  /beta/repositories:
    get:
      tags:
      - Repository Management
      summary: getRepositories
      description: List repositories
      operationId: getRepositories
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/Content-Type'
      responses:
        '200':
          description: Repositories list returned
          headers: {}
          content: {}
        '401':
          description: Authentication required
          headers: {}