Device42 Device Ignore Rules API

openapi: 3.2.0
info:
  title: Device42 Device Ignore Rules API
  version: '2.0'
  description: 'API Overview


    RESTful APIs are supported in Device42 as one of the primary methods of entering, editing and retrieving data.'
  contact:
    name: Device42
    email: support@device42.com
servers:
- url: https://<host>
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: Device Ignore Rules
paths:
  /api/2.0/device_ignore_rules/:
    get:
      operationId: getDevice_Ignore_Rules
      description: This call will get all device ignore rules
      summary: Get all
      tags:
      - Device Ignore Rules
      responses:
        '200':
          description: 'The above command returns results like this:'
          content:
            application/json:
              schema:
                properties:
                  total_count:
                    example: 1
                  limit:
                    example: 1000
                  DeviceIgnoreRules:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          example: 1
                        text:
                          example: macad-test
                        option_type:
                          example: 3
                        device_type_id:
                          example: 2
                        device_type:
                          example: physical
                        physicalsubtype_id:
                          example: 1009
                        physicalsubtype:
                          example: ats
                        virtualsubtype_id:
                          example: 2
                        virtualsubtype:
                          example: Amazon EC2 Instance
                        last_discovery:
                          example: 2020-05-21 14:42
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
    post:
      description: This call creates or updates a device ignore rule
      summary: Create/update
      tags:
      - Device Ignore Rules
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                id:
                  description: Required to update an existing ignore rule - the D42 ID of the rule.
                  type: string
                text:
                  description: Text for the ignore rule - in UI, 'Ignored text contains'.
                  type: string
                option_type:
                  description: Type of ignore rule for the device - in UI, 'Ignore device based on'.<br> 1 = Device name<br> 2 = OS name<br> 3 = Mac address prefix<br> 4 = Hardware model<br> 5 = Tag<br> 6 = Device type
                  type: string
                  enum:
                  - '1'
                  - '2'
                  - '3'
                  - '4'
                  - '5'
                  - '6'
                text_length_match_type:
                  description: Exact, partial or prefix/suffix matching for length of ignore rule text.<br> 1 = Partial match<br> 2 = Exact match<br> 3 = Begins with<br> 4 = Ends with
                  type: string
                  enum:
                  - '1'
                  - '2'
                  - '3'
                  - '4'
                text_case_match_type:
                  description: 'Case sensitivity match for ignore rule text.<br> 1 = Case insensitive<br> 2 = Case sensitive            '
                  type: string
                  enum:
                  - '1'
                  - '2'
                device_type_id:
                  description: Device type ID<br>1. unknown 2. physical<br> 3. virtual 4. cluster
                  type: string
                  enum:
                  - '1'
                  - '2'
                  - '3'
                  - '4'
                device_type:
                  description: Device type by name.
                  type: string
                  enum:
                  - unknown
                  - physical
                  - virtual
                  - cluster
                physicalsubtype_id:
                  description: Used to set the device subtype - the device must be physical or unknown.<br> 1. Generic 2. Rackable 3. Blade 4. PDU 5. Access Point 6. CRAC 7. UPS 8. TAP 9. Branch Circuit Power Meter 10. Power Unit 11. WorkStation 12. ThinClient 13. Network Printer 14. Laptop 15. Environment Monitor<br><b> OR</b> D42 ID of user-generated subtype
                  type: string
                physicalsubtype:
                  description: Either a system-generated subtype name or a user-generated subtype name.
                  type: string
                virtualsubtype_id:
                  description: Virtual subtype id. Only for virtual devices. <br>1. Internal VM 2. Amazon EC2 Instance 3. Azure Cloud Service <br>4. Azure SQL Server 5. Azure Storage 6. Other <br>7. Outscale Instance 8. Linode Instance 9. DigitalOcean Instance <br>10. Azure Virtual Machine 11. VMWare 12. Citrix/Xen <br>13. KVM 14. Hyper-V 15. Docker Container <br>16. LXC Container 17. Rackspace VM 18. Softlayer VM <br>19. QEMU 20. Joyent Instance 21. VirtualBox <br>22. Oracle VM 23. OpenStack 24. Xen <br>25. LPAR 26. GCE 27. Amazon Service <br>28. Context 29. Alibaba Cloud Instance 30. Oracle Cloud Instance <br>31. Kubernetes Container 32. AIX VIOS 33. Nutanix AHV
                  type: string
                  enum:
                  - '1'
                  - '2'
                  - '3'
                  - '4'
                  - '5'
                  - '6'
                  - '7'
                  - '8'
                  - '9'
                  - '10'
                  - '11'
                  - '12'
                  - '13'
                  - '14'
                  - '15'
                  - '16'
                  - '17'
                  - '18'
                  - '19'
                  - '20'
                  - '21'
                  - '22'
                  - '23'
                  - '24'
                  - '25'
                  - '26'
                  - '27'
                  - '28'
                  - '29'
                  - '30'
                  - '31'
                  - '32'
                  - '33'
                virtualsubtype:
                  description: Virtual subtype name. Use instead of virtualsubtype_id. Only for virtual device type.
                  type: string
                  enum:
                  - Internal VM
                  - Amazon EC2 Instance
                  - Azure Cloud Service
                  - Azure SQL Server
                  - Azure Storage
                  - Other
                  - Outscale Instance
                  - Linode Instance
                  - DigitalOcean Instance
                  - Azure Virtual Machine
                  - VMWare
                  - Citrix/Xen
                  - KVM
                  - Hyper-V
                  - Docker Container
                  - LXC Container
                  - Rackspace VM
                  - Softlayer VM
                  - QEMU
                  - Joyent Instance
                  - VirtualBox
                  - Oracle VM
                  - OpenStack
                  - Xen
                  - LPAR
                  - GCE
                  - Amazon Service
                  - Context
                  - Alibaba Cloud Instance
                  - Oracle Cloud Instance
                  - Kubernetes Container
                  - AIX VIOS
                last_discovery:
                  description: The last time this rule was applied to ignore a device during discovery (YYYY-MM-DD HH:MM).
                  type: string
              required:
              - option_type
      responses:
        '200':
          description: 'The above command returns results like this:'
          content:
            application/json:
              schema:
                properties:
                  msg:
                    example:
                    - Device ignore rule added/updated
                    - 11
                    - dtm-device-2
                    - true
                    - true
                  code:
                    example: 0
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      operationId: postDevice_Ignore_Rules
  /api/2.0/device_ignore_rules/{id}/:
    delete:
      operationId: deleteDevice_Ignore_Rules
      summary: Delete
      description: Used to delete a device ignore rule with the rule ID as the required argument
      tags:
      - Device Ignore Rules
      parameters:
      - name: id
        in: path
        required: true
        description: D42 ID of the ignore rule to delete.
        schema:
          type: string
      responses:
        '200':
          description: 'The above command returns results like this:'
          content:
            application/json:
              schema:
                properties:
                  deleted:
                    example: 'true'
                  id:
                    example: '11'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
components:
  responses:
    Forbidden:
      description: Forbidden (The resource requested is hidden)
      content:
        application/json:
          example:
            errors:
            - code: 403
              reason: Forbidden
              title: Forbidden
              detail: The resource requested is hidden
    BadRequest:
      description: Bad Request (A validation exception has occurred.)
      content:
        application/json:
          example:
            errors:
            - code: 400
              reason: BAD_REQUEST
              title: The error response code title.
              detail: Details of the error response.
    Unauthorized:
      description: Unauthorized (Invalid credentials.)
      content:
        application/json:
          example:
            errors:
            - code: 401
              reason: Unauthorized
              title: Unauthorized
              detail: Invalid credentials.
    InternalServerError:
      description: Internal Server Error (A required parameter is missing or there is an issue with the server. Check the returned 'msg' field from the call.)
      content:
        application/json:
          example:
            errors:
            - code: 500
              reason: Internal Server Error
              title: Internal Server Error
              detail: A required parameter is missing or there is an issue with the server. Check the returned 'msg' field from the call.
    NotFound:
      description: Not Found (The specified resource could not be found)
      content:
        application/json:
          example:
            errors:
            - code: 404
              reason: Not Found
              title: Not Found
              detail: The specified resource could not be found.
    ServiceUnavailable:
      description: Service Unavailable (Please check if your Device42 instance is working normally.)
      content:
        application/json:
          example:
            errors:
            - code: 503
              reason: Service Unavailable
              title: Service Unavailable
              detail: Please check if your Device42 instance is working normally.
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: Basic authentication using a Device42 user's username and password.
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer token obtained from POST /tauth/1.0/token/ using an API Client's key/secret as Basic auth credentials.