Verta MonitoredEntityService API

swagger: '2.0'
info:
  title: deployment/APISync.proto AuthzService MonitoredEntityService API
  version: version not set
basePath: /v1
consumes:
- application/json
produces:
- application/json
tags:
- name: MonitoredEntityService
paths:
  /api/v1/monitoring/monitored_entity/createMonitoredEntity:
    post:
      operationId: MonitoredEntityService_createMonitoredEntity
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/monitoringCreateMonitoredEntityRequestResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/runtimeError'
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/monitoringCreateMonitoredEntityRequest'
      tags:
      - MonitoredEntityService
  /api/v1/monitoring/monitored_entity/deleteMonitoredEntity:
    delete:
      operationId: MonitoredEntityService_deleteMonitoredEntity
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/monitoringDeleteMonitoredEntityRequestResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/runtimeError'
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/monitoringDeleteMonitoredEntityRequest'
      tags:
      - MonitoredEntityService
  /api/v1/monitoring/monitored_entity/findMonitoredEntity:
    post:
      operationId: MonitoredEntityService_findMonitoredEntity
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/monitoringFindMonitoredEntityRequestResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/runtimeError'
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/monitoringFindMonitoredEntityRequest'
      tags:
      - MonitoredEntityService
  /api/v1/monitoring/monitored_entity/updateMonitoredEntity:
    patch:
      operationId: MonitoredEntityService_updateMonitoredEntity
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/monitoringUpdateMonitoredEntityRequestResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/runtimeError'
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/monitoringUpdateMonitoredEntityRequest'
      tags:
      - MonitoredEntityService
definitions:
  monitoringUpdateMonitoredEntityRequestResponse:
    type: object
    properties:
      monitored_entity:
        $ref: '#/definitions/monitoringMonitoredEntity'
  monitoringCreateMonitoredEntityRequestResponse:
    type: object
    properties:
      monitored_entity:
        $ref: '#/definitions/monitoringMonitoredEntity'
  protobufAny:
    type: object
    properties:
      type_url:
        type: string
      value:
        type: string
        format: byte
  commonGroupId:
    type: object
    properties:
      org_id:
        type: string
      group_id:
        type: string
  runtimeError:
    type: object
    properties:
      error:
        type: string
      code:
        type: integer
        format: int32
      message:
        type: string
      details:
        type: array
        items:
          $ref: '#/definitions/protobufAny'
  uacCollaboratorPermissions:
    type: object
    properties:
      collaborator_type:
        $ref: '#/definitions/CollaboratorTypeEnumCollaboratorType'
      can_deploy:
        $ref: '#/definitions/TernaryEnumTernary'
      can_predict:
        $ref: '#/definitions/TernaryEnumTernary'
  monitoringDeleteMonitoredEntityRequestResponse:
    type: object
  monitoringFindMonitoredEntityRequestResponse:
    type: object
    properties:
      monitored_entities:
        type: array
        items:
          $ref: '#/definitions/monitoringMonitoredEntity'
      total_records:
        type: integer
        format: int32
  monitoringUpdateMonitoredEntityRequest:
    type: object
    properties:
      id:
        type: string
        format: uint64
      name:
        type: string
      attributes:
        type: object
        additionalProperties:
          type: string
      resource_visibility:
        $ref: '#/definitions/uacResourceVisibility'
      custom_permission:
        $ref: '#/definitions/uacCollaboratorPermissions'
        title: 'The next field only makes sense when visibility == ORG_CUSTOM

          They will be empty otherwise'
  uacResourceVisibility:
    type: string
    enum:
    - UNKNOWN
    - ORG_DEFAULT
    - ORG_CUSTOM
    - PRIVATE
    - WORKSPACE_DEFAULT
    default: UNKNOWN
  monitoringFindMonitoredEntityRequest:
    type: object
    properties:
      ids:
        type: array
        items:
          type: string
          format: uint64
      names:
        type: array
        items:
          type: string
      fuzzy_names:
        type: array
        items:
          type: string
        title: Add names to find with a fuzzy (non-exact) search
      endpoint_ids:
        type: array
        items:
          type: string
          format: uint64
      model_version_ids:
        type: array
        items:
          type: string
      workspace_id:
        type: string
        format: uint64
      workspace_name:
        type: string
      page_number:
        type: integer
        format: int32
        title: Pagination
      page_limit:
        type: integer
        format: int32
  TernaryEnumTernary:
    type: string
    enum:
    - UNKNOWN
    - 'TRUE'
    - 'FALSE'
    default: UNKNOWN
  monitoringMonitoredEntity:
    type: object
    properties:
      id:
        type: string
        format: uint64
      name:
        type: string
      workspace_id:
        type: string
        format: uint64
      created_at_timestamp_millis:
        type: string
        format: uint64
      updated_at_timestamp_millis:
        type: string
        format: uint64
      attributes:
        type: object
        additionalProperties:
          type: string
      owner:
        type: string
        title: owner's verta_id
      owner_id:
        type: string
        format: uint64
      group_owner_id:
        $ref: '#/definitions/commonGroupId'
      resource_visibility:
        $ref: '#/definitions/uacResourceVisibility'
      custom_permission:
        $ref: '#/definitions/uacCollaboratorPermissions'
        title: 'The next field only makes sense when visibility == ORG_CUSTOM

          They will be empty otherwise'
      version_number:
        type: string
        format: uint64
      endpoint_id:
        type: string
        format: uint64
      datasource_name:
        type: string
      origin:
        type: string
        title: a tag that says where the data for this monitored entity comes from. eg. "endpoint" or "batch"
  monitoringCreateMonitoredEntityRequest:
    type: object
    properties:
      name:
        type: string
      workspace_id:
        type: string
        format: uint64
      workspace_name:
        type: string
      attributes:
        type: object
        additionalProperties:
          type: string
      resource_visibility:
        $ref: '#/definitions/uacResourceVisibility'
      custom_permission:
        $ref: '#/definitions/uacCollaboratorPermissions'
        title: 'The next field only makes sense when visibility == ORG_CUSTOM

          They will be empty otherwise'
      endpoint_id:
        type: string
        format: uint64
        description: Optional.  If the data originates from a Verta endpoint, set this to the endpoint id.
      origin:
        type: string
        title: a tag that says where the data for this monitored entity comes from. eg. "endpoint" or "batch"
  monitoringDeleteMonitoredEntityRequest:
    type: object
    properties:
      id:
        type: string
        format: uint64
  CollaboratorTypeEnumCollaboratorType:
    type: string
    enum:
    - READ_ONLY
    - READ_WRITE
    default: READ_ONLY