Xcel Energy EndDevice API

openapi: 3.2.0
info:
  title: Xcel Energy Smart Meter IEEE 2030.5 End Device API
  summary: IEEE 2030.5 (SEP 2.0) REST API exposed by Itron Gen 5 Riva smart meters on the local network.
  description: IEEE 2030.5 / Smart Energy Profile 2.0 compliant API server built into Itron Gen 5 Riva smart meters deployed by Xcel Energy.
  version: '1.0'
  contact:
    name: Xcel Energy Developer Portal
    url: https://developer-apim.aws.xcelenergy.com/
  x-generated-from: documentation
  x-last-validated: '2026-05-03'
  x-standards:
  - IEEE 2030.5-2018
  - Smart Energy Profile 2.0
servers:
- url: https://{meterHost}
  description: Itron Gen 5 Riva smart meter on the local network (mTLS).
  variables:
    meterHost:
      default: 192.168.1.10
      description: Hostname or IP of the local meter device.
tags:
- name: EndDevice
  description: End devices managed by the meter (the meter itself and any subordinate devices).
paths:
  /edev:
    get:
      operationId: listEndDevices
      summary: List EndDevices
      description: Returns the EndDeviceList containing all EndDevices managed by the server.
      tags:
      - EndDevice
      security:
      - mtls: []
      parameters:
      - $ref: '#/components/parameters/StartIndex'
      - $ref: '#/components/parameters/Limit'
      responses:
        '200':
          description: EndDeviceList resource.
          content:
            application/sep+xml:
              schema:
                $ref: '#/components/schemas/EndDeviceList'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createEndDevice
      summary: Register a new EndDevice
      description: Posts a new EndDevice resource to register a client with the server.
      tags:
      - EndDevice
      security:
      - mtls: []
      requestBody:
        required: true
        content:
          application/sep+xml:
            schema:
              $ref: '#/components/schemas/EndDevice'
      responses:
        '201':
          description: EndDevice created. The Location header contains the new resource URI.
          headers:
            Location:
              schema:
                type: string
              description: URI of the new EndDevice resource.
        '400':
          $ref: '#/components/responses/BadRequest'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /edev/{edevId}:
    get:
      operationId: getEndDevice
      summary: Get an EndDevice
      description: Returns a single EndDevice resource identified by edevId.
      tags:
      - EndDevice
      security:
      - mtls: []
      parameters:
      - $ref: '#/components/parameters/EdevId'
      responses:
        '200':
          description: EndDevice resource.
          content:
            application/sep+xml:
              schema:
                $ref: '#/components/schemas/EndDevice'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: updateEndDevice
      summary: Update an EndDevice
      description: Replaces an existing EndDevice resource.
      tags:
      - EndDevice
      security:
      - mtls: []
      parameters:
      - $ref: '#/components/parameters/EdevId'
      requestBody:
        required: true
        content:
          application/sep+xml:
            schema:
              $ref: '#/components/schemas/EndDevice'
      responses:
        '204':
          description: EndDevice updated successfully.
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteEndDevice
      summary: Delete an EndDevice
      tags:
      - EndDevice
      security:
      - mtls: []
      parameters:
      - $ref: '#/components/parameters/EdevId'
      responses:
        '204':
          description: EndDevice removed.
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  parameters:
    EdevId:
      name: edevId
      in: path
      required: true
      description: Numeric identifier of an EndDevice resource.
      schema:
        type: integer
        minimum: 0
        example: 0
    Limit:
      name: l
      in: query
      required: false
      description: Maximum number of list items to return.
      schema:
        type: integer
        minimum: 1
        maximum: 255
        example: 25
    StartIndex:
      name: s
      in: query
      required: false
      description: 0-based start index for paginated lists.
      schema:
        type: integer
        minimum: 0
        example: 0
  schemas:
    EndDevice:
      allOf:
      - $ref: '#/components/schemas/Resource'
      - type: object
        properties:
          sFDI:
            type: integer
            format: int64
            description: Short-form device identifier.
          lFDI:
            type: string
            description: Long-form device identifier (32 hex characters).
          deviceCategory:
            type: string
            description: Hex-encoded DeviceCategoryType.
          postRate:
            type: integer
          enabled:
            type: boolean
          changedTime:
            type: integer
          RegistrationLink:
            $ref: '#/components/schemas/Link'
          DeviceInformationLink:
            $ref: '#/components/schemas/Link'
          DeviceStatusLink:
            $ref: '#/components/schemas/Link'
          PowerStatusLink:
            $ref: '#/components/schemas/Link'
          LogEventListLink:
            $ref: '#/components/schemas/Link'
          ConfigurationLink:
            $ref: '#/components/schemas/Link'
          FunctionSetAssignmentsListLink:
            $ref: '#/components/schemas/Link'
    Link:
      type: object
      description: Link to another resource in the IEEE 2030.5 graph.
      properties:
        href:
          type: string
    EndDeviceList:
      allOf:
      - $ref: '#/components/schemas/Resource'
      - type: object
        properties:
          all:
            type: integer
          results:
            type: integer
          EndDevice:
            type: array
            items:
              $ref: '#/components/schemas/EndDevice'
    Resource:
      type: object
      description: Base IEEE 2030.5 Resource type that all resources inherit from.
      properties:
        href:
          type: string
          description: Stable URI of the resource.
  responses:
    BadRequest:
      description: The request body or parameters were invalid.
    NotFound:
      description: The requested resource was not found.
  securitySchemes:
    mtls:
      type: mutualTLS
      description: 'IEEE 2030.5 requires mutual TLS authentication. Clients present a device certificate whose subject contains the LFDI/SFDI used to authorize access. Plain HTTP is not permitted.

        '