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-certificate-instances-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 Certificate Instances 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: Certificate Instances
paths:
  /api/1.0/certificate_instances/:
    get:
      operationId: getCertificateInstances
      summary: Get
      description: This API is used to return the certificate instances you have added or discovered in Device42
      tags:
      - Certificate Instances
      parameters:
      - name: certificate_id
        in: query
        description: filter by certificate_id
        schema:
          type: integer
      - name: device_id
        in: query
        description: filter by device_id
        schema:
          type: integer
      - name: device
        in: query
        description: filter by device name
        schema:
          type: string
      - name: fqdn
        in: query
        description: filter by fqdn
        schema:
          type: string
      responses:
        '200':
          description: 'The above command returns results like this:'
          content:
            application/json:
              schema:
                properties:
                  total_count:
                    example: '1'
                  certificate_details:
                    type: array
                    items:
                      $ref: '#/components/schemas/Get_certificate_instances'
        '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: postUpdateCertificateInstances
      summary: Create/update
      description: This API is used to update or add new certificate instances in bulk.
      tags:
      - Certificate Instances
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                id:
                  description: ID is only required if updating an existing certificate instance
                  type: integer
                device_id:
                  description: The ID of the device associated with the certificate instance. Required if device is not provided.
                  type: integer
                device:
                  description: The device name or alias associated with the certificate instance. Required if device_id is not provided.
                  type: string
                certificate_id:
                  description: The ID of the certificate associated with the certificate instance. Required if certificate is not provided.
                  type: integer
                certificate:
                  description: The name of the certificate associated with the certificate instance. Required if certificate_id is not provided.
                  type: string
                fqdn:
                  description: Fully qualified domain name
                  type: string
                ip:
                  description: IP address
                  type: string
                valid_from:
                  description: 'The start date of the certificate. Only filled if different than associated certificate. YYYY-MM-DD format        '
                  type: string
                valid_to:
                  description: The expiration date of the certificate. Only filled if different than associated certificate. YYYY-MM-DD format
                  type: string
                serial_number:
                  description: Serial Number
                  type: string
                ssl_version:
                  description: SSL version
                  type: string
                cipher_suites:
                  description: Cipher suites supported by the certificate in json format. e.g. - {'TLSv1.0':'["TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA","TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA"]'}
                  type: string
      responses:
        '200':
          description: 'The above command returns results like this:'
          content:
            application/json:
              schema:
                properties:
                  msg:
                    example:
                    - Certificate instance added/updated successfully
                    - 1
                    - example.com - DEVICEA2Z001
                    - 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/certificate_instances/{ID}/:
    get:
      operationId: getCertificateInstancesById
      summary: Get
      description: This API is used to return the certificate instances you have added or discovered in Device42
      tags:
      - Certificate Instances
      parameters:
      - name: ID
        in: path
        description: certificate instance id
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: 'The above command returns results like this:'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Get_certificate_instances'
        '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: deleteCertificateInstanceById
      summary: Delete
      description: This API is used to delete the certificate instance with the certificate instance id supplied as the required argument
      tags:
      - Certificate Instances
      parameters:
      - name: ID
        in: path
        description: certificate instance 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'
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:
    Get_certificate_instances:
      type: object
      properties:
        id:
          type: integer
          example: 1
          description: The unique ID of the certificate instance.
        ip:
          type: string
          example: 192.168.1.1
          description: The IP address associated with the certificate instance.
        valid_from:
          type: string
          format: date
          example: '2024-01-01'
          description: The date when the certificate becomes valid.
        valid_to:
          type: string
          format: date
          example: '2025-12-31'
          description: The certificate's expiration date.
        device_id:
          type: integer
          example: 1
          description: The device ID associated with the certificate.
        device:
          type: string
          example: example-device
          description: The device name associated with the certificate instance.
        certificate_id:
          type: integer
          example: 1
          description: The unique ID of the certificate.
        certificate:
          type: string
          example: example.com
          description: The domain associated with the certificate.
        cipher_suites:
          type: object
          additionalProperties:
            type: string
          example:
            TLSv1.2: TLS_RSA_WITH_AES_256_CBC_SHA
          description: Supported cipher suites for the certificate.
        fqdn:
          type: string
          example: example.com
          description: Fully Qualified Domain Name.
        serial_number:
          type: string
          example: ABC1234567890
          description: The certificate's serial number.
        ssl_version:
          type: string
          example: TLSv1.2
          description: SSL version used.
        last_added:
          type:
          - string
          - 'null'
          format: date-time
          example: null
          description: The date and time when the certificate instance was last added.
        first_added:
          type: string
          format: date-time
          example: '2024-01-01T00:00:00Z'
          description: The date and time when the certificate instance was first added.
  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.