Tessell infra-deployment API

The infra-deployment API from Tessell — 1 operation(s) for infra-deployment.

OpenAPI Specification

tessell-infra-deployment-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Tessell APIs activity-center infra-deployment API
  contact:
    email: support@tessell.com
    name: Tessell Inc
    url: https://www.tessell.com
  description: Tessell API Documentation
  termsOfService: https://www.tessell.com/terms
  version: '1.0'
servers:
- url: '{server}'
  variables:
    server:
      default: console.tessell.com
tags:
- name: infra-deployment
paths:
  /infra-deployments/regions:
    get:
      tags:
      - infra-deployment
      description: Returns the regions supported for subscription creation
      summary: Get regions
      operationId: getRegions
      parameters:
      - in: header
        name: tenant-id
        schema:
          type: string
          format: uuid
        required: true
        description: Tenant Id
      - in: query
        name: cloud-type
        schema:
          $ref: '#/components/schemas/cloudType'
        required: true
        description: Cloud type
      - in: query
        name: return-private-cp-dp-regions
        schema:
          type: boolean
        required: false
        description: “Determines whether only regions with Private CP-DP enabled should be returned.”
      - name: Authorization
        in: header
        description: Authorization Token
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Regions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenantRegionsResponse'
        default:
          description: API error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorOps'
components:
  schemas:
    TenantRegionsResponse:
      title: TenantRegionsResponse
      properties:
        regions:
          type: array
          items:
            type: string
    TessellHTTPErrorCode:
      type: object
      properties:
        httpCode:
          type: integer
          description: HTTP code
        code:
          type: string
          description: Tessell's specific code with more context on error
    ApiErrorOps:
      type: object
      description: Common error response object for non 2xx responses of internal or ops APIs
      properties:
        code:
          type: string
          description: Status code for the error response
        message:
          type: string
          description: Error message for API response
        resolution:
          type: string
        timestamp:
          type: string
          format: date-time
        contextId:
          type: string
          description: ContextId of API request
        sessionId:
          type: string
          description: SessionId of API request
        tessellErrorCode:
          type: string
          description: Unique error code specific to Tessell
        userView:
          $ref: '#/components/schemas/TessellExceptionUserView'
    TessellExceptionUserView:
      title: TessellExceptionUserView
      type: object
      properties:
        message:
          type: string
          description: End-user representation of the message
        resolution:
          type: string
          description: End-user representation of resolution
        errorCode:
          $ref: '#/components/schemas/TessellHTTPErrorCode'
          description: User specific code might be different in some cases with internal code (Say some internal entity is not present, so 404 for Tessell while 500 for end-user
    cloudType:
      description: Tessell supported cloud types
      type: string
      enum:
      - AWS
      - AZURE
      - GCP
      - OCI
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer