Signicat Monitor Endpoints API

openapi: 3.2.0
info:
  title: Signicat Monitor Endpoints API
  version: ''
  contact: ''
  license: ''
  termsOfService: ''
  x-meta: Custom metadata
  description: 'Operations tagged Monitor Endpoints across 2 of this provider''s published API definitions: ongoing-monitoring-openapi.json, signicat-ongoing-monitoring-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.signicat.com/
tags:
- name: Monitor Endpoints
paths:
  /info/monitor/{monitorId}:
    get:
      tags:
      - Monitor Endpoints
      summary: Get monitor
      description: This endpoint allows to get monitor by Id from the system.
      operationId: GetMonitor
      parameters:
      - name: monitorId
        in: path
        description: Unique GUID identifier of the monitor.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitorDto'
              example:
                id: 402d1ce2-ce71-4f9b-b252-3fa90fef0de4
                accountId: a-ppge-c5jsmhR5fLM3jxBY8H1v
                name: Monitor Name
                sources:
                - name: trapets
                profiles:
                - screening
                description: Monitor that reach source
                size: 10
                entityType: Organisation
                createdAt: '2026-10-16T14:12:59.0694094Z'
                isActive: true
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
    servers:
    - url: https://api.signicat.com/
  /info/monitor:
    post:
      tags:
      - Monitor Endpoints
      summary: Create monitor
      description: This endpoint allows the creation of a new monitor resource in the system.
      operationId: CreateMonitor
      requestBody:
        description: Request object to create a monitor.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateMonitorRequestDto'
            example:
              name: Monitor Name
              description: Monitor that reach source
              entityType: Organisation
              sources:
              - name: trapets
              profiles:
              - screening
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiOperationResponse'
              example:
                status: 200
                message: Entity with reference key spar01 is in the process of being delete
                monitorId: 019e8cc8-bb2c-7f4d-fae0-1eaf7aaa0cc9
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
    servers:
    - url: https://api.signicat.com/
  /info/monitor/update/{monitorId}:
    patch:
      tags:
      - Monitor Endpoints
      summary: Update monitor
      description: This endpoint allows the update of a existing monitor resource in the system.
      operationId: UpdateMonitor
      parameters:
      - name: monitorId
        in: path
        description: Unique GUID identifier of the monitor.
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        description: Request object to update a monitor.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateMonitorRequestDto'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitorDto'
              example:
                id: 402d1ce2-ce71-4f9b-b252-3fa90fef0de4
                accountId: a-ppge-c5jsmhR5fLM3jxBY8H1v
                name: Monitor Name
                sources:
                - name: trapets
                profiles:
                - screening
                description: Monitor that reach source
                size: 10
                entityType: Organisation
                createdAt: '2026-10-16T14:12:59.0724777Z'
                isActive: true
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
    servers:
    - url: https://api.signicat.com/
components:
  schemas:
    MonitorDto:
      required:
      - accountId
      - entityType
      - id
      - name
      type: object
      properties:
        id:
          minLength: 1
          type: string
          description: The ID of the monitor
        accountId:
          type: string
          description: The ID of the account that the monitor belongs to
        name:
          type: string
          description: The name of the monitor
        sources:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SourcesDto'
          description: The sources that monitor the entities
        profiles:
          type:
          - array
          - 'null'
          items:
            maxLength: 100
            minLength: 1
            type: string
          description: A list of profiles associated with the monitor.
        description:
          type:
          - string
          - 'null'
          description: Description of the monitor
        size:
          type: integer
          description: The count of monitored entities
          format: int32
        entityType:
          minLength: 1
          type: string
          description: The type of monitored entities (e.g., 'Person', 'Organisation')
        createdAt:
          type: string
          description: Monitor creation date and time
          format: date-time
        isActive:
          type: boolean
          description: Indicates whether the monitor is currently active.
      additionalProperties: false
    ApiOperationResponse:
      type: object
      properties:
        status:
          type: integer
          description: Represents the status of the operation, typically corresponding to an HTTP status code.
          format: int32
        message:
          type:
          - string
          - 'null'
          description: Provides a descriptive message related to the outcome of the API operation.
        monitorId:
          type:
          - string
          - 'null'
          description: Represents the unique identifier of a monitor resource.
          format: uuid
      additionalProperties: false
    CreateMonitorRequestDto:
      required:
      - entityType
      - name
      - profiles
      - sources
      type: object
      properties:
        name:
          maxLength: 100
          minLength: 1
          type: string
          description: The name of the monitor.
        description:
          maxLength: 100
          minLength: 1
          type:
          - string
          - 'null'
          description: Description of the monitor.
        entityType:
          maxLength: 100
          minLength: 1
          type: string
          description: The type of monitored entities (e.g., 'Person', 'Organisation').
        sources:
          maxItems: 50
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/SourcesDto'
          description: A collection of sources associated with the monitor.
        profiles:
          maxItems: 50
          minItems: 1
          type: array
          items:
            maxLength: 100
            minLength: 1
            type: string
          description: A list of profiles associated with the monitor request. Each profile must be a non-empty string.
      additionalProperties: false
    UpdateMonitorRequestDto:
      type: object
      properties:
        isActive:
          type:
          - boolean
          - 'null'
      additionalProperties: false
    SourcesDto:
      required:
      - name
      type: object
      properties:
        name:
          maxLength: 100
          minLength: 1
          type: string
          description: Represents the name of a source.
      additionalProperties: false
x-refined-from:
- ongoing-monitoring-openapi.json
- signicat-ongoing-monitoring-openapi.yml