Cycloid Projects API

openapi: 3.0.3
info:
  title: Cycloid HTTP CloudCost Projects API
  description: The Cycloid HTTP API is the programmatic surface of the Cycloid Internal Developer Portal & Platform. It enables management of organizations, projects, environments, infrastructure resources, pipelines, service catalogs (Stacks and StackForms), credentials, config repositories, cloud cost dashboards, inventory and state, and audit events. Authentication uses an API key (passed via header or `api_key` query parameter) or OAuth2 with refresh tokens. The canonical Swagger / Redoc reference is published at docs.cycloid.io.
  version: '1.0'
  contact:
    name: Cycloid Support
    url: https://www.cycloid.io
    email: contact@cycloid.io
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: https://http-api.cycloid.io
  description: Cycloid production HTTP API
security:
- ApiKeyAuth: []
- OAuth2: []
tags:
- name: Projects
  description: Projects and environments inside an organization.
paths:
  /organizations/{organization_canonical}/projects:
    get:
      tags:
      - Projects
      summary: List projects
      operationId: listProjects
      parameters:
      - $ref: '#/components/parameters/OrganizationCanonical'
      responses:
        '200':
          description: Projects
    post:
      tags:
      - Projects
      summary: Create project
      operationId: createProject
      parameters:
      - $ref: '#/components/parameters/OrganizationCanonical'
      responses:
        '201':
          description: Project created
  /organizations/{organization_canonical}/projects/{project_canonical}/environments:
    get:
      tags:
      - Projects
      summary: List environments
      operationId: listEnvironments
      parameters:
      - $ref: '#/components/parameters/OrganizationCanonical'
      - $ref: '#/components/parameters/ProjectCanonical'
      responses:
        '200':
          description: Environments
components:
  parameters:
    OrganizationCanonical:
      name: organization_canonical
      in: path
      required: true
      schema:
        type: string
    ProjectCanonical:
      name: project_canonical
      in: path
      required: true
      schema:
        type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://console.cycloid.io/oauth/authorize
          tokenUrl: https://http-api.cycloid.io/oauth/token
          refreshUrl: https://http-api.cycloid.io/oauth/refresh
          scopes:
            organization:read: Read organization data
            organization:write: Modify organization data
externalDocs:
  description: Cycloid API Documentation
  url: https://docs.cycloid.io