Device42 Cables API

openapi: 3.2.0
info:
  title: Device42 Cables 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: Cables
paths:
  /api/1.0/cables/:
    get:
      operationId: getCables
      summary: Get all
      description: Retrieve information about all cables
      tags:
      - Cables
      parameters:
      - name: cable_id
        in: query
        description: filter by cable_id
        schema:
          type: integer
      responses:
        '200':
          description: 'The above command returns results like this:'
          content:
            application/json:
              schema:
                properties:
                  cable:
                    type: array
                    items:
                      $ref: '#/components/schemas/Cable'
        '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:
      operationId: postCables
      description: Create/update cable information
      summary: Create/update
      tags:
      - Cables
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                ID:
                  description: Device42 ID of cable
                  type: string
                cable_id:
                  description: Cable ID/Name
                  type: string
                vendor:
                  description: Cable vendor
                  type: string
                notes:
                  description: Any additional notes
                  type: string
                groups:
                  description: If multitenancy is on, admin groups that have access to this object are specified here, e.g. Prod_East:no,Corp:yes specifies that the admin groups for this object are Prod_East with view only permission and Corp with change permission. If this parameter is present with no value, all groups are deleted.
                  type: string
                room_id:
                  description: Room ID
                  type: string
                room:
                  description: Room name
                  type: string
                origin_clear:
                  description: Option to clean up cable origin
                  type: string
                  enum:
                  - 'yes'
                  - 'no'
                origin_type:
                  description: Type of origin point.
                  type: string
                  enum:
                  - cable
                  - circuit
                  - switchport
                  - tap_port
                  - patch_panel_port
                origin_id:
                  description: ID of the origin point. <b>Must be used with origin_type</b>
                  type: integer
                origin_connector_type:
                  description: Connector Type (User Definable)
                  type: string
                origin_cable_type:
                  description: Cable Type (User definable)
                  type: string
                origin_cable_color:
                  description: Origin Cable Color
                  type: string
                origin_optic_type:
                  description: Optic Type (Definable, ie multimode)
                  type: string
                origin_back_patch_panel:
                  type: string
                end_clear:
                  description: Option to clean up cable endpoint
                  type: string
                  enum:
                  - 'yes'
                  - 'no'
                end_point_type:
                  description: Type of end point.
                  type: string
                  enum:
                  - cable
                  - circuit
                  - switchport
                  - tap_port
                  - patch_panel_port
                  - vendor
                end_point_id:
                  description: ID of the end point. <b>Must be used with end_point_type</b>
                  type: integer
                end_connector_type:
                  description: Connector Type (User Definable)
                  type: string
                end_cable_type:
                  description: Endpoint Cable Type (User Definable)
                  type: string
                end_cable_color:
                  description: Endpoint Cable Color
                  type: string
                end_optic_type:
                  description: Optic Type (Definable, ie multimode)
                  type: string
                end_point_back_pach_panel:
                  type: string
                end_point_multiple:
                  description: yes to allow multiple endpoints
                  type: string
                  enum:
                  - 'yes'
                  - 'no'
                cable_length:
                  description: Length of Cable
                  type: string
                cable_length_units:
                  description: Units for Cable Length (“m” or “ft”)
                  type: string
              required:
              - cable_id
      responses:
        '200':
          description: 'The above command returns results like this:'
          content:
            application/json:
              schema:
                properties:
                  msg:
                    example:
                    - cable added/updated
                    - 9
                    - 'Cable #9 [new Cable]'
                    - true
                    - false
                  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'
  /api/1.0/cables/{id}/:
    delete:
      operationId: deleteCable
      summary: Delete
      description: This API is used to delete the cable with the ID supplied as the required argument
      tags:
      - Cables
      parameters:
      - name: id
        in: path
        description: Cable ID
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: 'The above command returns results like this:'
          content:
            application/json:
              schema:
                properties:
                  deleted:
                    example: 'true'
                  id:
                    example: '89'
        '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.
  schemas:
    Cable:
      type: object
      properties:
        cable_id:
          example: Fiber 1:Multi
        cable_length:
          example: ''
        cable_length_units:
          example: m
        custom_fields:
          example: []
        end_back_patch_panel:
          example: false
        end_cable_color:
          example: ''
        end_cable_type:
          example: ''
        end_connector_type:
          example: ''
        end_content_type:
          example: cable
        end_optic_type:
          example: ''
        end_point_multiple:
          example: true
        id:
          example: 3
        notes:
          example: ''
        origin_back_patch_panel:
          example: false
        origin_cable_color:
          example: ''
        origin_cable_type:
          example: ''
        origin_connector_type:
          example: ''
        origin_content_type:
          example: netport
        origin_netport_id:
          example: 899
        origin_netport_name:
          example: ''
        origin_optic_type:
          example: ''
        room:
          example: ''
        tags:
          example: []
        vendor:
          example: ''
  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.