Spectro Cloud activations API

The activations API from Spectro Cloud — 1 operation(s) for activations.

OpenAPI Specification

spectro-cloud-activations-api-openapi.yml Raw ↑
swagger: '2.0'
info:
  title: Local Management APIs activations API
  version: v1
servers:
- url: https://edge-host-ip:5080
schemes:
- http
- https
consumes:
- application/json
produces:
- application/json
tags:
- name: activations
  x-displayName: Activations
paths:
  /v1/activations/system:
    get:
      description: Only for UI to show the banner
      operationId: v1ActivationsSystemGet
      parameters:
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        type: string
      responses:
        '200':
          description: Successful operation
          schema:
            $ref: '#/definitions/v1ActivationsSystemResponse'
        '400':
          description: Invalid request data
          schema:
            $ref: '#/definitions/v1Error'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Returns system activation state from in-memory cache for UI banner
      tags:
      - activations
definitions:
  v1Time:
    description: Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON.  Wrappers are provided for many of the factory methods that the time package offers.
    format: date-time
    type: string
  v1Error:
    properties:
      code:
        type: string
      details:
        type: object
      message:
        type: string
      ref:
        type: string
    type: object
  v1ActivationsSystemResponse:
    properties:
      status:
        properties:
          expiresAt:
            $ref: '#/definitions/v1Time'
          state:
            enum:
            - Active
            - Pending
            - Inactive
            type: string
        required:
        - state
        type: object
    type: object
securityDefinitions:
  Authorization:
    description: JWT authorization token obtained using /v1/users/default/login API
    type: apiKey
    name: Authorization
    in: header