find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/device42:device42-telco-circuits-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Device42 Telco Circuits 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: Telco Circuits
paths:
  /api/1.0/circuits/:
    get:
      operationId: getCircuits
      description: Get all circuits
      summary: Get all
      tags:
      - Telco Circuits
      parameters:
      - name: id
        in: query
        description: ID for the circuit (D42 ID)
        schema:
          type: integer
      - $ref: '#/components/parameters/circuit_id'
      - name: type
        in: query
        description: Type of circuit
        schema:
          type: string
      - name: origin_type
        in: query
        description: Type of origin point.
        schema:
          type: string
          enum:
          - cable
          - circuit
          - switchport
          - vendor
          - patch_panel_port
      - $ref: '#/components/parameters/origin_id'
      - name: end_point_type
        in: query
        description: Type of end point.
        schema:
          type: string
          enum:
          - cable
          - circuit
          - switchport
          - vendor
          - patch_panel_port
      - $ref: '#/components/parameters/end_point_id'
      responses:
        '200':
          description: 'The above command returns results like this:'
          content:
            application/json:
              schema:
                properties:
                  circuits:
                    type: array
                    items:
                      $ref: '#/components/schemas/Get_all_Circuits'
        '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: post_Update_Circuits
      description: Create/update circuits
      summary: Create/update
      tags:
      - Telco Circuits
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                ID:
                  description: ID for the specific circuit (D42 ID)
                  type: integer
                circuit_id:
                  description: general circuit ID - required for new circuits
                  type: string
                type:
                  description: type of circuit - required for new circuits
                  type: string
                order_date:
                  description: Format is YYYY-MM-DD
                  type: string
                provision_date:
                  description: Format is YYYY-MM-DD
                  type: string
                turn_on_date:
                  description: Format is YYYY-MM-DD
                  type: string
                expiration_date:
                  description: Format is YYYY-MM-DD
                  type: string
                notes:
                  description: Any additional notes
                  type: string
                bandwidth:
                  description: bandwidth in kbps (multiply factor of 1024)
                  type: integer
                vendor:
                  description: The cloud vendor
                  type: string
                vendor_id:
                  description: ID of the vendor
                  type: integer
                customer:
                  description: customer name
                  type: string
                customer_id:
                  description: ID of the customer
                  type: integer
                dmarc:
                  description: name of the DMARC
                  type: string
                dmarc_id:
                  description: ID of the DMARC
                  type: integer
                origin_type:
                  description: Type of origin point. <b>Must be used with origin_id</b>
                  type: string
                  enum:
                  - cable
                  - circuit
                  - switchport
                  - vendor
                  - patch_panel_port
                origin_id:
                  description: ID of the origin point. <b>Must be used with origin_type</b>
                  type: integer
                origin_circuit_id:
                  description: if origin type is circuit, this is circuit_id of the circuit. Absent otherwise
                  type: string
                origin_switchport:
                  description: if origin type is switchport, this is name of the switch port. Used with origin_switch. Absent otherwise
                  type: string
                origin_switch:
                  description: if origin type is switchport, this is name of the switch. Absent otherwise. Used with origin_switchport
                  type: string
                origin_port_id:
                  description: ID of the Origin Port. This will set the origin type to 'switchport' and assign the port ID.
                  type: integer
                origin_patch_panel_port:
                  description: if origin type is patch_panel_port, this is name of the patch panel port. Absent otherwise
                  type: string
                origin_patch_panel:
                  description: if origin type is patch_panel_port, this is name of the patch panel. Absent otherwise
                  type: string
                origin_patch_panel_id:
                  description: if origin type is patch_panel_port, this is ID of the patch panel. Absent otherwise
                  type: integer
                origin_back_patch_panel:
                  description: If the origin object is a patch panel port, this parameter can be used indicate the circuit is on the back of the patch panel or not.
                  type: string
                  enum:
                  - 'yes'
                  - 'no'
                origin_vendor:
                  description: if origin type is vendor, this is name of the vendor. Absent otherwise
                  type: string
                end_point_type:
                  description: Type of end point. <b>Must be used with end_point_id</b>
                  type: string
                  enum:
                  - cable
                  - circuit
                  - switchport
                  - vendor
                  - patch_panel_port
                end_point_id:
                  description: ID of the end point. <b>Must be used with end_point_type</b>
                  type: integer
                end_point_circuit_id:
                  description: if end_point type is circuit, this is circuit_id of the circuit. Absent otherwise
                  type: string
                end_point_switchport:
                  description: if end_point type is switchport, this is name of the switch port. Used with end_point_switch. Absent otherwise
                  type: string
                end_point_switch:
                  description: if end_point type is switchport, this is name of the switch. Used with end_point_switchport. Absent otherwise
                  type: string
                end_port_id:
                  description: ID of the Endpoint Port. This will set the endpoint type to 'switchport' and assign the port ID.
                  type: integer
                end_point_patch_panel_port:
                  description: if end_point type is patch_panel_port, this is name of the patch panel port. Absent otherwise
                  type: string
                end_point_patch_panel:
                  description: if end_point type is patch_panel_port, this is name of the patch panel. Absent otherwise
                  type: string
                end_point_patch_panel_id:
                  description: if end_point type is patch_panel_port, this is ID of the patch panel. Absent otherwise
                  type: integer
                end_back_patch_panel:
                  description: If the endpoint object is a patch panel port, this parameter can be used indicate the circuit is on the back of the patch panel or not.
                  type: string
                  enum:
                  - 'yes'
                  - 'no'
                end_point_vendor:
                  description: if end_point type is vendor, this is name of the vendor. Absent otherwise
                  type: string
                origin_clear:
                  description: providing this parameter (any value) will clear the origin object from the circuit.
                  type: string
                end_clear:
                  description: providing this parameter (any value) will clear the endpoint object from the circuit.
                  type: string
                status:
                  description: Circuit status
                  type: string
                new_circuit_id:
                  description: providing this parameter (string) will change the circuit id of the circuit.
                  type: string
      responses:
        '200':
          description: 'The above command returns results like this:'
          content:
            application/json:
              schema:
                properties:
                  msg:
                    example:
                    - Circuit added/updated
                    - 49
                    - chicago-main
                    - 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'
  /api/1.0/circuits/{id}/:
    get:
      operationId: getCircuitsByID
      description: Get circuit by ID
      summary: Get specific circuit by ID
      tags:
      - Telco Circuits
      parameters:
      - name: id
        in: path
        description: ID for the circuit (D42 ID)
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: 'The above command returns results like this:'
          content:
            application/json:
              schema:
                properties:
                  circuits:
                    type: array
                    items:
                      $ref: '#/components/schemas/Get_all_Circuits'
        '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'
    delete:
      operationId: deleteCircuit
      summary: Delete
      description: This API is used to delete the circuit with the circuit id supplied as the required argument
      tags:
      - Telco Circuits
      parameters:
      - name: id
        in: path
        description: circuit 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: '114'
        '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/custom_fields/circuit/:
    put:
      operationId: put_Custom_Fields
      description: Create/update custom fields for circuits. (Added in v5.9.3) Either ID or circuit_id is required
      summary: Custom fields
      tags:
      - Telco Circuits
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                ID:
                  description: ID for the cricuit (D42 ID)
                  type: string
                circuit_id:
                  description: circuit_id for the circuit
                  type: string
                key:
                  description: Can be new or existing. This is the custom field name.
                  type: string
                type:
                  description: this is the custom field type. If left blank, default is text. Date should be formatted as YYYY-MM-DD
                  type: string
                  enum:
                  - text
                  - number
                  - date
                  - related_field
                  - boolean
                  - url
                  - picklist
                  - json
                  - markup
                mandatory:
                  description: Is custom field mandatory? yes/no
                  type: string
                  enum:
                  - 'yes'
                  - 'no'
                filterable:
                  description: Is custom field filterable? yes/no
                  type: string
                  enum:
                  - 'yes'
                  - 'no'
                log_for_api:
                  description: Log custom field? yes/no
                  type: string
                  enum:
                  - 'yes'
                  - 'no'
                related_field_name:
                  description: Required if type = related_field. The existing field to relate this custom field to. Below are details for some of the fields that have been renamed or require further clarification. appcomp (for application components), businessapp (for Business Service), circuit (for Telco Circuit), cloudinfrastructure (for Cloud Account),  hardware (for device hardware model), netport (for Switch Port), organisation (for Vendor), pdu (for Power Unit), pdu_model (for Power Unit Model), purchase (for Purchase Order), software (for Software Component), vlan (for Subnet)
                  type: string
                  enum:
                  - appcomp
                  - building
                  - businessapp
                  - certificate
                  - circuit
                  - cloudinfrastructure
                  - costcenter
                  - customer
                  - device
                  - dns_zone
                  - endusers
                  - hardware
                  - ip_address
                  - netport
                  - organisation
                  - os
                  - pdu
                  - pdu_model
                  - powercircuit
                  - purchase
                  - rack
                  - room
                  - servicecategory
                  - software_category
                  - software
                  - vlan
                add_to_picklist:
                  description: Comma separated values to add to picklist. If type is picklist and custom field is new, this is a required field. Duplicates will be ignored.
                  type: string
                remove_from_picklist:
                  description: Comma separated values to be removed from picklist. Duplicates will be ignored. Values that are in use will Not be deleted, unless <b>delete_in_use</b> parameter is provided and set to <b>yes</b>
                  type: string
                delete_in_use:
                  description: pass in <b>yes</b> if you want to delete Picklist value that is in use. Used in conjunction with <b>remove_from_picklist</b>.
                  type: string
                  enum:
                  - 'yes'
                  - 'no'
                related_field_value_by_id:
                  description: Select yes if you want to set the related field value by ID.
                  type: string
                  enum:
                  - 'yes'
                  - 'no'
                value:
                  description: This will set the value of the custom field for the specific object.
                  type: string
                clear_value:
                  description: yes to clear existing value for that field
                  type: string
                  enum:
                  - 'yes'
                  - 'no'
                notes:
                  description: Any additional notes
                  type: string
                clear_notes:
                  description: Yes to clear any existing notes
                  type: string
                  enum:
                  - 'yes'
                  - 'no'
                bulk_fields:
                  description: comma separated key value pairs, with key and value separated by colon. e.g.key1:value1, key2:value2
                  type: string
                multi_select:
                  description: Applies only to Picklist fields. Is custom field multi select? yes/no
                  type: string
                  enum:
                  - 'yes'
                  - 'no'
              required:
              - key
      responses:
        '200':
          description: 'The above command returns results like this:'
          content:
            application/json:
              schema:
                properties:
                  msg:
                    example:
                    - custom key pair values added or updated
                    - 1
                    - chicago-main
                    - 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'
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.
  parameters:
    circuit_id:
      name: circuit_id
      in: query
      description: circuit id
      schema:
        type: string
    end_point_id:
      name: end_point_id
      in: query
      description: ID of the end point
      schema:
        type: integer
    origin_id:
      name: origin_id
      in: query
      description: ID of the origin point
      schema:
        type: integer
  schemas:
    Get_all_Circuits:
      type: object
      properties:
        ID:
          example: 1
        bandwidth:
          example: ''
        circuit_id:
          example: L3-01
        custom_fields:
          type: array
          items:
            properties:
              key:
                example: Region
              notes:
                example: ''
              value:
                example: APAC
        customer:
          example: ABC Inc.
        end_point_id:
          example: 124
        end_point_type:
          example: patch_panel_port
        notes:
          example: ''
        origin_id:
          example: 193
        origin_type:
          example: vendor
        origin_vendor:
          example: TF1
        provision_date:
          example: ''
        turn_on_date:
          example: ''
        type:
          example: Dedicated Ethernet
        vendor:
          example: ''
        full_path_list:
          type: array
          items:
            properties:
              type:
                type: string
              id:
                type: integer
              name:
                type: string
          example:
          - type: organisation
            id: 193
            name: TF1
          - type: circuit
            id: 1
            name: L3-01
          - type: patch_panel_port
            id: 124
            name: 'MDF-CORE-A : 24'
  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.