WP Engine Status API

The Status API from WP Engine — 1 operation(s) for status.

OpenAPI Specification

wpengine-status-api-openapi.yml Raw ↑
swagger: '2.0'
info:
  description: 'The API described in this document is subject to change.

    '
  version: 1.17.0
  title: WP Engine Hosting Platform Account Status API
  termsOfService: https://wpengine.com/legal/terms-of-service/
host: api.wpengineapi.com
basePath: /v1
schemes:
- https
tags:
- name: Status
paths:
  /status:
    get:
      tags:
      - Status
      summary: The status of the WP Engine Hosting Platform API
      description: '# Description

        This endpoint will report the system status and any outages that might be occurring.

        '
      operationId: status
      produces:
      - application/json
      responses:
        '200':
          description: Status of API
          schema:
            $ref: '#/definitions/Status'
        '429':
          $ref: '#/definitions/TooManyRequestsOperation'
        '503':
          $ref: '#/definitions/ServiceUnavailableOperation'
      x-amazon-apigateway-integration:
        uri: https://my.wpengine.com/capi/v1/status
        responses:
          '200':
            statusCode: '200'
          '429':
            statusCode: '429'
          '503':
            statusCode: '503'
          default:
            statusCode: '500'
        requestParameters:
          integration.request.header.X-Request-ID: context.requestId
          integration.request.header.sourceIp: context.identity.sourceIp
        passthroughBehavior: when_no_match
        httpMethod: GET
        type: http
definitions:
  ServiceUnavailableOperation:
    description: Service unavailable
  Status:
    type: object
    properties:
      success:
        type: boolean
        example: true
      created_on:
        type: string
        example: '2018-05-17T16:20:40+00:00'
        description: The time when the status was requested in rfc3339 format
  TooManyRequestsOperation:
    description: Too many requests
securityDefinitions:
  basicAuth:
    type: basic
    description: 'API username and password from Portal''s API Access page: https://my.wpengine.com/api_access'