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-power-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 Power 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: Power Circuits
paths:
  /api/1.0/powercircuits/:
    get:
      operationId: get_All_Power_Circuits
      description: Get all power circuits
      summary: Get all
      tags:
      - Power Circuits
      parameters:
      - name: breakerpanel_id
        in: query
        description: Breaker panel ID
        schema:
          type: string
      - $ref: '#/components/parameters/bcpm_id'
      responses:
        '200':
          description: 'The above command returns results like this:'
          content:
            application/json:
              schema:
                properties:
                  power_circuits:
                    type: array
                    items:
                      $ref: '#/components/schemas/Get_all_Power_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_PowerCircuits
      description: Create/update power circuit
      summary: Create/update
      tags:
      - Power Circuits
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                id:
                  description: Power circuit ID. Required if breakerpanel_id and number is not provided.
                  type: integer
                breakerpanel_id:
                  description: Breaker panel ID. Required if id is not provided.Used to identify the power circuit when the ID is not provided and to update the breaker panel association when the ID is provided.
                  type: string
                number:
                  description: Number of the circuit on the breaker panel. Required if id is not provided.
                  type: string
                label:
                  description: Label of the circuit on the breaker panel
                  type: string
                connection:
                  description: Description of the connection for the circuit
                  type: string
                voltage:
                  description: The rated voltage on this circuit
                  type: string
                amps:
                  description: The rated amps on this circuit
                  type: string
                powerunit_connection_ids:
                  description: A comma-separated list of PU IDs connected to this circuit
                  type: string
                device_connection_ids:
                  description: A comma-separated list of device IDs connected to this circuit
                  type: string
                device_connection_names:
                  description: A comma-separated list of device names connected to this circuit
                  type: string
                asset_connection_ids:
                  description: A comma-separated list of asset IDs connected to this circuit
                  type: string
                new_number:
                  description: Providing this parameter (string) will change the circuit number of the circuit.
                  type: string
      responses:
        '200':
          description: 'The above command returns results like this:'
          content:
            application/json:
              schema:
                properties:
                  msg:
                    example:
                    - power circuit added/updated
                    - 89
                    - Server Room/4
                    - 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/powercircuits/{id}/:
    delete:
      operationId: deletePowerCircuit
      summary: Delete
      description: This API is used to delete the power circuit with the ID supplied as the required argument
      tags:
      - Power Circuits
      parameters:
      - name: id
        in: path
        description: Power 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: '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.
  parameters:
    bcpm_id:
      name: bcpm_id
      in: query
      description: Branch Circuit Power Meter ID
      schema:
        type: string
  schemas:
    Get_all_Power_Circuits:
      type: object
      properties:
        amps:
          example: ''
        asset_connections:
          example: []
        bcpm:
          example: ''
        bcpm_id:
          example: ''
        breakerpanel:
          example: Primary Breaker Panel
        breakerpanel_id:
          example: '10'
        connection:
          example: ''
        device_connections:
          example: []
        label:
          example: Testing Circuits
        number:
          example: Main Power Circuit
        power_circuit_id:
          example: '85'
        powerunit_connections:
          example: []
        voltage:
          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.