Device42 Device Name Profile API

openapi: 3.2.0
info:
  title: Device42 Device Name Profile 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 Name Profile
paths:
  /api/1.0/device_name_profile/:
    get:
      operationId: getdevice_name_profile
      description: This call will get all device name profiles
      summary: Get all
      tags:
      - Device Name Profile
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                name:
                  description: Used to easily identify different profiles for generating device names.
                  type: string
      responses:
        '200':
          description: 'The above command returns results like this:'
          content:
            application/json:
              schema:
                properties:
                  total_count:
                    example: 1
                  limit:
                    example: 1000
                  device_name_profiles:
                    type: array
                    items:
                      type: object
                      properties:
                        start_number:
                          example: 1
                        last_used:
                          example: 0
                        suffix:
                          example: SuffixOne
                        number_length:
                          example: 4
                        prefix:
                          example: PrefixOne
                        id:
                          example: 9
                        name:
                          example: DevNameProfile-One
        '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 name profile
      summary: Create/update
      tags:
      - Device Name Profile
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                name:
                  description: Used to easily identify different profiles for generating device names.
                  type: string
                number_length:
                  description: Number length between 2 and 7. For numbers up to 9999, it would be 4. Default is 4.
                  type: integer
                start_number:
                  description: Starting number, where you want device numbers to start from. Default is 1.
                  type: integer
                last_used:
                  description: DO NOT CHANGE, unless you know what it is used for :). Default is 0.
                  type: integer
                prefix:
                  description: Prefix for the generated name number; e.g., SecretDC-Server in SecretDC-Server0042.
                  type: string
                suffix:
                  description: Suffix for the generated name number; e.g., .domain.pvt in SecretDC-Server0042.domain.pvt.
                  type: string
              required:
              - name
              - number_length
              - start_number
              - last_used
        required: true
      responses:
        '200':
          description: 'The above command returns results like this:'
          content:
            application/json:
              schema:
                properties:
                  msg:
                    example:
                    - device_name_profile added/updated
                    - 11
                    - DevNameProfile-Five
                    - 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_name_profile
  /api/1.0/device_name_profile/{id}/:
    delete:
      operationId: deletedevice_name_profile
      summary: Delete
      description: This API is used to delete a device name profile with the device name profile id supplied as the required argument
      tags:
      - Device Name Profile
      parameters:
      - name: id
        in: path
        required: true
        description: device name profile id
        schema:
          type: integer
      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.