Equinix Console Log Details API

Console Log Details. Notice: This is a test feature currently under active development, and only available to certain users. Please contact Customer Success for more information.

OpenAPI Specification

equinix-console-log-details-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: Equinix API Authentication Console Log Details API
  description: 'Equinix APIs use the OAuth 2.0 for authentication and authorization. Equinix supports the resource owner password and the client credentials flow.

    To begin, obtain OAuth 2.0 client credentials from the Equinix Developer Console under "My Apps". Then your client application  requests an access token from the Equinix API Authorization endpoint, extracts the access_token from the response, and sends the Bearer token to the API that you want to access'
  termsOfService: https://www.equinix.com/about/legal/terms
  contact:
    name: Equinix API Support
    url: https://docs.equinix.com/api-support.htm
  version: '1.2'
servers:
- url: https://api.equinix.com
tags:
- description: 'Console Log Details. Notice: This is a test feature currently under active development, and only available to certain users. Please contact Customer Success for more information.

    '
  name: Console Log Details
paths:
  /devices/{id}/diagnostics/screenshot:
    get:
      description: Capture a screenshot from the device, if supported, via the BMC.
      operationId: captureScreenshot
      parameters:
      - description: Device UUID
        in: path
        name: id
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/jpeg:
              schema:
                format: binary
                type: string
          description: An image file
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: not found
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: not implemented for device
      tags:
      - Console Log Details
components:
  schemas:
    Error:
      description: Error responses are included with 4xx and 5xx HTTP responses from the API service. Either "error" or "errors" will be set.
      properties:
        error:
          description: A description of the error that caused the request to fail.
          type: string
        errors:
          description: A list of errors that contributed to the request failing.
          items:
            description: An error message that contributed to the request failing.
            type: string
          type: array
      type: object
x-eqx-api-linter-skip-rules:
- 3
- 38