openapi: 3.1.0
info:
  title: Spot Administration Access Policies Cloud Credentials API
  description: The Spot Administration API provides endpoints for managing organizations, accounts, users, access policies, cloud credentials, subscriptions, and event notifications within the Spot by Flexera platform. It enables programmatic control over user permissions, account setup, and cloud provider credential linking for AWS, Azure, and GCP.
  version: 2.0.0
  contact:
    name: Spot by Flexera
    url: https://docs.spot.io/
  termsOfService: https://spot.io/terms-of-use/
servers:
- url: https://api.spotinst.io
  description: Spot Production API
security:
- bearerAuth: []
tags:
- name: Cloud Credentials
  description: Link and validate cloud provider credentials for AWS, Azure, and GCP accounts.
paths:
  /setup/credentials/aws:
    post:
      operationId: setAWSCloudCredentials
      summary: Spot Set Aws Cloud Credentials
      description: Link a Spot account to an AWS cloud account.
      tags:
      - Cloud Credentials
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AWSCredentialsRequest'
            examples:
              SetawscloudcredentialsRequestExample:
                summary: Default setAWSCloudCredentials request
                x-microcks-default: true
                value:
                  credentials:
                    iamRole: example_value
      responses:
        '200':
          description: Successful response
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /setup/credentials/azure:
    post:
      operationId: setAzureCloudCredentials
      summary: Spot Set Azure Cloud Credentials
      description: Link a Spot account to an Azure subscription.
      tags:
      - Cloud Credentials
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AzureCredentialsRequest'
            examples:
              SetazurecloudcredentialsRequestExample:
                summary: Default setAzureCloudCredentials request
                x-microcks-default: true
                value:
                  credentials:
                    clientId: '500123'
                    clientSecret: example_value
                    tenantId: '500123'
                    subscriptionId: '500123'
      responses:
        '200':
          description: Successful response
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /setup/credentials/gcp:
    post:
      operationId: setGCPCloudCredentials
      summary: Spot Set Gcp Cloud Credentials
      description: Link a Spot account to a GCP project.
      tags:
      - Cloud Credentials
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GCPCredentialsRequest'
            examples:
              SetgcpcloudcredentialsRequestExample:
                summary: Default setGCPCloudCredentials request
                x-microcks-default: true
                value:
                  credentials:
                    serviceAccount: example_value
      responses:
        '200':
          description: Successful response
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    AzureCredentialsRequest:
      type: object
      properties:
        credentials:
          type: object
          properties:
            clientId:
              type: string
            clientSecret:
              type: string
            tenantId:
              type: string
            subscriptionId:
              type: string
          example: example_value
    GCPCredentialsRequest:
      type: object
      properties:
        credentials:
          type: object
          properties:
            serviceAccount:
              type: object
              description: GCP service account JSON key.
          example: example_value
    AWSCredentialsRequest:
      type: object
      properties:
        credentials:
          type: object
          properties:
            iamRole:
              type: string
              description: The ARN of the IAM role to use.
          example: example_value
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Spot API uses Bearer Token Authentication. Include your API token in the Authorization header.