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-operating-systems-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 Operating Systems 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: Operating Systems
paths:
  /api/1.0/operatingsystems/:
    get:
      operationId: getOperatingSystems
      description: This call will get information about operating systems
      summary: Get all
      tags:
      - Operating Systems
      parameters:
      - name: name
        in: query
        description: Filter by OS name
        schema:
          type: string
      - name: manufacturer
        in: query
        description: Filter by OS manufacturer
        schema:
          type: string
      - name: category
        in: query
        description: 'Filter by OS category (ie: Linux, Windows)'
        schema:
          type: string
      responses:
        '200':
          description: 'The above command returns results like this:'
          content:
            application/json:
              schema:
                properties:
                  operatingsystems:
                    type: array
                    items:
                      $ref: '#/components/schemas/OperatingSystems'
        '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: postOperatingSystems
      description: This call will create/update information about operating systems
      summary: Create/update
      tags:
      - Operating Systems
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                name:
                  description: name of the OS
                  type: string
                manufacturer:
                  description: name of the hardware/software manufacturer.
                  type: string
                notes:
                  description: Any additional notes
                  type: string
                category:
                  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. Use for initial insert.
                  type: string
                licensed_count:
                  description: Number of purchased licenses of operating system
                  type: string
                licensing_model:
                  type: string
      responses:
        '200':
          description: 'The above command returns results like this:'
          content:
            application/json:
              schema:
                properties:
                  msg:
                    example:
                    - Operating System added/updated
                    - 77
                    - ESX6.0
                    - false
                    - 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/operatingsystems/{id}/:
    get:
      operationId: getOperatingSystemsID
      summary: Get specific
      description: Retrieve detailed information about a specific OS by os id.
      tags:
      - Operating Systems
      parameters:
      - name: id
        in: path
        required: true
        description: The ID of the OS to retrieve
        schema:
          type: integer
      responses:
        '200':
          description: 'The above command returns results like this:'
          content:
            application/json:
              schema:
                properties:
                  operatingsystems:
                    type: array
                    items:
                      $ref: '#/components/schemas/OperatingSystems'
        '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: deleteOperatingSystems
      summary: Delete
      description: This API is used to delete the operating system with the operating system id supplied as the required argument
      tags:
      - Operating Systems
      parameters:
      - name: id
        in: path
        required: true
        description: opearting system id
        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/device_os/:
    get:
      operationId: getDevice_os
      summary: Get by devices
      description: This call will get information about operating systems and the devices they're discovered on. This call will also return device os Data Normalization results, if available.
      tags:
      - Operating Systems
      parameters:
      - name: id
        in: query
        description: ID of Device OS to retrieve
        schema:
          type: integer
      - $ref: '#/components/parameters/os'
      - $ref: '#/components/parameters/os_id'
      responses:
        '200':
          description: 'The above command returns results like this:'
          content:
            application/json:
              schema:
                properties:
                  total_count:
                    example: 598
                  device_os:
                    type: array
                    items:
                      $ref: '#/components/schemas/Device_os'
                  limit:
                    example: 1000
                  offset:
                    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'
    post:
      operationId: postDevice_os
      description: This call will create or update operating systems and assign them to a device
      summary: Create/Update on device
      tags:
      - Operating Systems
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                device_os_id:
                  description: ID of specific operating system.<br><br>Use this parameter to change an existing device OS - or -  use the device_id parameter AND the os parameter.<br><br>Do not use this parameter to create a new device OS.
                  type: string
                device_id:
                  description: ID of the device the OS is assigned to.<br><br>Use this parameter AND the os parameter to create a new device OS.
                  type: string
                device:
                  description: Name of device the OS is assigned to.
                  type: string
                os_id:
                  description: ID of OS
                  type: string
                os:
                  description: Operating system name.<br><br>Use this parameter to create or change a device OS. See the device parameters above.
                  type: string
                osver:
                  description: Operating system version name
                  type: string
                osverno:
                  description: Operating system version number
                  type: string
                license_key:
                  description: OS license key
                  type: string
                count_in_licensing:
                  description: Whether or not to count OS in licensing
                  type: string
                  enum:
                  - 'yes'
                  - 'no'
      responses:
        '200':
          description: 'The above command returns results like this:'
          content:
            application/json:
              schema:
                properties:
                  msg:
                    example:
                    - device_os added/updated
                    - 9
                    - Production-server (Ubuntu Linux 16.04 (64-bit))
                    - 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/device_os/{device_os_id}/:
    get:
      operationId: getDevice_osID
      summary: Get specific
      description: Retrieve detailed information about a specific Device OS by device os id.
      tags:
      - Operating Systems
      parameters:
      - name: device_os_id
        in: path
        required: true
        description: The ID of the Device OS to retrieve
        schema:
          type: integer
      responses:
        '200':
          description: 'The above command returns results like this:'
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    example: 1
                  device_os:
                    type: array
                    items:
                      type: object
                      properties:
                        discovered_license_key:
                          example: ''
                        os_id:
                          example: 2
                        osver:
                          example: ''
                        dont_change_via_api:
                          example: 'no'
                        device:
                          example: NHCTS003
                        device_os_id:
                          example: 2
                        license_key:
                          example: ''
                        osverno:
                          example: ''
                        os:
                          example: Microsoft Windows Server 2008 STD
                        id:
                          example: 2
                        count_in_licensing:
                          example: 'yes'
                        device_id:
                          example: 120
                  limit:
                    example: 1000
                  offset:
                    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'
    delete:
      operationId: deleteDevice_os
      summary: Delete
      description: This API is used to delete the operating system with the operating system id supplied as the required argument
      tags:
      - Operating Systems
      parameters:
      - name: device_os_id
        in: path
        description: ID of specific operating system
        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: 9
        '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/os_eoleos/:
    get:
      operationId: getOS_eol_eos
      summary: Get OS EOL/EOS
      description: Get Operating Systems End of Life / End of Support Information
      tags:
      - Operating Systems
      responses:
        '200':
          description: 'The above command returns results like this:'
          content:
            application/json:
              schema:
                properties:
                  values:
                    type: array
                    items:
                      type: object
                      properties:
                        version:
                          example: 4.4.0-53-generic
                        id:
                          example: 1
                        os_id:
                          example: 21
                        end_of_life:
                          example: '2017-11-15'
                        end_of_support:
                          example: '2017-11-30'
                        os:
                          example: Ubuntu
        '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: postOS_eol_eos
      description: This call will create or update an Operating Systems End of Life / End of Support
      summary: Create/Update OS EOL/EOS
      tags:
      - Operating Systems
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                os:
                  description: Name of Operating System. 'os' or 'os_id' is REQUIRED when creating a new OS EOL/EOS.
                  type: string
                os_id:
                  description: ID of Operating System. 'os' or 'os_id' is REQUIRED when creating a new OS EOL/EOS.
                  type: integer
                version:
                  description: Version of OS
                  type: string
                end_of_life_date:
                  description: End of Life date. Format is YYYY-MM-DD
                  type: string
                end_of_support_date:
                  description: End of Support date. Format is YYYY-MM-DD
                  type: string
      responses:
        '200':
          description: 'The above command returns results like this:'
          content:
            application/json:
              schema:
                properties:
                  code:
                    example: 0
                  msg:
                    example:
                    - O/S EOL/EOS successfully added/updated
                    - 9
                    - Ubuntu / None
                    - true
                    - true
        '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/os_eoleos/{ID}/:
    delete:
      operationId: deleteOS_eol_eos
      summary: Delete OS EOL/EOS
      description: This API is used to delete the an Operating Systems End of Life / End of Support
      tags:
      - Operating Systems
      parameters:
      - name: ID
        in: path
        description: ID of OS EOS/EOL
        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: 9
        '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:
    OperatingSystems:
      type: object
      properties:
        aliases:
          example: []
        category:
          example: ''
        id:
          example: 1
        licensed_count:
          example: 5
        manufacturer:
          example: ''
        name:
          example: Microsoft Windows 7 Professional
        not_licensed_count:
          example: 0
        notes:
          example: ''
        total_count:
          example: 5
        discovered_license_count:
          example: 5
        enriched_data:
          type: object
          properties:
            service_pack:
              example: ''
            vendor:
              example: Juniper
            os_version:
              example: '12.3'
            golden_record_id:
              example: gros_00000571
            os_version_no:
              example: ''
            eol:
              example: '2023-11-23 00:00:00'
            eos:
              example: '2027-03-01 00:00:00'
            edition:
              example: ''
            os_architecture:
              example: ''
            os_family:
              example: '*nix'
            enriched_os:
              example: Juniper Junos OS
            id:
              example: 3,
            os_name:
              example: Junos OS
    Device_os:
      type: object
      properties:
        discovered_license_key:
          example: ''
        os_id:
          example: 2
        osver:
          example: 12.3R12-S1
        dont_change_via_api:
          example: 'no'
        device:
          example: sb-n15-10
        device_os_id:
          example: 2
        license_key:
          example: ''
        osverno:
          example: ''
        os:
          example: junos
        id:
          example: 2
        count_in_licensing:
          example: 'yes'
        device_id:
          example: 120
        enriched_data:
          type: object
          properties:
            service_pack:
              example: ''
            vendor:
              example: Juniper
            os_version:
              example: '12.3'
            golden_record_id:
              example: gros_00000571
            os_version_no:
              example: ''
            eol:
              example: '2023-11-23 00:00:00'
            eos:
              example: '2027-03-01 00:00:00'
            edition:
              example: ''
            os_architecture:
              example: ''
            os_family:
              example: '*nix'
            enriched_os:
              example: Juniper Junos OS
            id:
              example: 3,
            os_name:
              example: Junos OS
  parameters:
    os_id:
      name: os_id
      in: query
      description: Operating system ID
      schema:
        type: string
    os:
      name: os
      in: query
      description: filter by OS name (added in v8.3.0)
      schema:
        type: string
  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.