Spectro Cloud clouds API
The clouds API from Spectro Cloud — 95 operation(s) for clouds.
The clouds API from Spectro Cloud — 95 operation(s) for clouds.
swagger: '2.0'
info:
title: Local Management APIs activations clouds API
version: v1
servers:
- url: https://edge-host-ip:5080
schemes:
- http
- https
consumes:
- application/json
produces:
- application/json
tags:
- name: clouds
x-displayName: Clouds
paths:
/v1/clouds/apache-cloudstack/account/validate:
post:
description: Validates CloudStack account credentials and domain. Verifies API connectivity and that the specified domain exists. Returns no contents if account is valid else error.
operationId: V1CloudStackAccountValidate
parameters:
- description: Request payload for CloudStack cloud account with required domain field
in: body
name: cloudstackCloudAccount
required: true
schema:
$ref: '#/definitions/v1CloudStackCloudAccount'
- 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:
'204':
description: Ok response without content
headers:
AuditUid:
description: Audit uid for the request
type: string
security:
- ApiKey: []
- Authorization: []
summary: Check if CloudStack account is valid
tags:
- clouds
/v1/clouds/apache-cloudstack/diskOfferings:
get:
operationId: V1CloudStackDiskOfferingsGet
parameters:
- description: Uid for the specific CloudStack cloud account
in: query
name: cloudAccountUid
type: string
- description: Zone for which CloudStack disk offerings are requested
in: query
name: zone
type: string
- description: Project ID for which CloudStack disk offerings are requested
in: query
name: projectId
type: string
- 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: (empty)
schema:
$ref: '#/definitions/v1CloudStackDiskOfferings'
security:
- ApiKey: []
- Authorization: []
summary: Returns the CloudStack disk offerings
tags:
- clouds
/v1/clouds/apache-cloudstack/domains:
get:
operationId: V1CloudStackDomainsGet
parameters:
- description: Uid for the specific CloudStack cloud account
in: query
name: cloudAccountUid
type: string
- 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: (empty)
schema:
$ref: '#/definitions/v1CloudStackDomains'
security:
- ApiKey: []
- Authorization: []
summary: Returns the CloudStack domains
tags:
- clouds
/v1/clouds/apache-cloudstack/keypairs:
get:
operationId: V1CloudStackKeypairsGet
parameters:
- description: Uid for the specific CloudStack cloud account
in: query
name: cloudAccountUid
type: string
- description: Domain ID for which CloudStack SSH key pairs are requested
in: query
name: domainId
type: string
- description: Project ID for which CloudStack SSH key pairs are requested
in: query
name: projectId
type: string
- 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: (empty)
schema:
$ref: '#/definitions/v1CloudStackKeypairs'
security:
- ApiKey: []
- Authorization: []
summary: Returns the CloudStack SSH key pairs
tags:
- clouds
/v1/clouds/apache-cloudstack/networks:
get:
operationId: V1CloudStackNetworksGet
parameters:
- description: Uid for the specific CloudStack cloud account
in: query
name: cloudAccountUid
type: string
- description: Zone for which CloudStack networks are requested
in: query
name: zone
type: string
- description: Project ID for which CloudStack networks are requested
in: query
name: projectId
type: string
- description: VPC ID for which CloudStack networks are requested
in: query
name: vpcId
type: string
- 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: (empty)
schema:
$ref: '#/definitions/v1CloudStackNetworks'
security:
- ApiKey: []
- Authorization: []
summary: Returns the CloudStack networks
tags:
- clouds
/v1/clouds/apache-cloudstack/offerings:
get:
operationId: V1CloudStackOfferingsGet
parameters:
- description: Uid for the specific CloudStack cloud account
in: query
name: cloudAccountUid
type: string
- description: Zone for which CloudStack offerings are requested
in: query
name: zone
type: string
- description: Project ID for which CloudStack offerings are requested
in: query
name: projectId
type: string
- description: Template ID for which CloudStack offerings are requested
in: query
name: templateId
type: string
- 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: (empty)
schema:
$ref: '#/definitions/v1CloudStackOfferings'
security:
- ApiKey: []
- Authorization: []
summary: Returns the CloudStack compute offerings
tags:
- clouds
/v1/clouds/apache-cloudstack/projects:
get:
operationId: V1CloudStackProjectsGet
parameters:
- description: Uid for the specific CloudStack cloud account
in: query
name: cloudAccountUid
type: string
- 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: (empty)
schema:
$ref: '#/definitions/v1CloudStackProjects'
security:
- ApiKey: []
- Authorization: []
summary: Returns the CloudStack projects
tags:
- clouds
/v1/clouds/apache-cloudstack/templates:
get:
operationId: V1CloudStackTemplatesGet
parameters:
- description: Uid for the specific CloudStack cloud account
in: query
name: cloudAccountUid
type: string
- description: Zone for which CloudStack templates are requested
in: query
name: zone
type: string
- description: Project ID for which CloudStack templates are requested
in: query
name: projectId
type: string
- description: Template IDs for which CloudStack templates are requested
in: query
items:
type: string
name: templateIds
type: array
- 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: (empty)
schema:
$ref: '#/definitions/v1CloudStackTemplates'
security:
- ApiKey: []
- Authorization: []
summary: Returns the CloudStack templates
tags:
- clouds
/v1/clouds/apache-cloudstack/vpcs:
get:
operationId: V1CloudStackVpcsGet
parameters:
- description: Uid for the specific CloudStack cloud account
in: query
name: cloudAccountUid
type: string
- description: Zone ID for which CloudStack VPCs are requested
in: query
name: zoneId
type: string
- description: Project ID for which CloudStack VPCs are requested
in: query
name: projectId
type: string
- 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: (empty)
schema:
$ref: '#/definitions/v1CloudStackVpcs'
security:
- ApiKey: []
- Authorization: []
summary: Returns the CloudStack Vpcs
tags:
- clouds
/v1/clouds/apache-cloudstack/zones:
get:
operationId: V1CloudStackZonesGet
parameters:
- description: Uid for the specific CloudStack cloud account
in: query
name: cloudAccountUid
type: string
- 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: (empty)
schema:
$ref: '#/definitions/v1CloudStackZones'
security:
- ApiKey: []
- Authorization: []
summary: Returns the CloudStack zones
tags:
- clouds
/v1/clouds/aws/account/secret/credentials:
post:
operationId: V1AwsAccountSecretCredentials
parameters:
- description: Retrieves the Aws secret credentials
in: body
name: account
required: true
schema:
$ref: '#/definitions/v1AwsSecretSpecInputEntity'
- 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: (empty)
schema:
$ref: '#/definitions/v1AwsAccountCredentials'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves the Aws secret credentials
tags:
- clouds
/v1/clouds/aws/account/sts:
get:
operationId: V1AwsAccountStsGet
parameters:
- default: aws
description: AWS accounts are scoped to a single partition. Allowed values [aws, aws-us-gov], Default values
enum:
- aws
- aws-us-gov
in: query
name: partition
type: string
- 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: (empty)
schema:
$ref: '#/definitions/V1AwsAccountSts'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves AWS external id and account id
tags:
- clouds
/v1/clouds/aws/account/validate:
post:
operationId: V1AwsAccountValidate
parameters:
- description: Request payload to validate AWS cloud account
in: body
name: awsCloudAccount
required: true
schema:
$ref: '#/definitions/v1AwsCloudAccount'
- 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:
'204':
description: Ok response without content
headers:
AuditUid:
description: Audit uid for the request
type: string
security:
- ApiKey: []
- Authorization: []
summary: Validate the specified AWS account credentials
tags:
- clouds
/v1/clouds/aws/amiTypes:
get:
operationId: V1AwsAmiTypes
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: (empty)
schema:
$ref: '#/definitions/v1AmiTypes'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a list of AWS AMI types
tags:
- clouds
/v1/clouds/aws/apiEndpoints:
get:
description: Retrieves all AWS partition endpoint configurations.
operationId: V1CloudsAwsApiEndpointsGet
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: OK
schema:
$ref: '#/definitions/v1AwsApiEndpointsConfig'
security:
- ApiKey: []
- Authorization: []
summary: Get AWS API endpoints configuration
tags:
- clouds
/v1/clouds/aws/cloudwatch/validate:
post:
description: Validates aws cloud watch credentials
operationId: V1CloudsAwsCloudWatchValidate
parameters:
- description: Request payload for cloud watch config
in: body
name: cloudWatchConfig
required: true
schema:
$ref: '#/definitions/v1.CloudWatchConfig'
- 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:
'204':
description: Ok response without content
headers:
AuditUid:
description: Audit uid for the request
type: string
security:
- ApiKey: []
- Authorization: []
summary: validates aws cloud watch credentials
tags:
- clouds
/v1/clouds/aws/cost:
post:
operationId: v1AwsCloudCost
parameters:
- description: Request payload for AWS cloud cost
in: body
name: body
required: true
schema:
$ref: '#/definitions/v1AwsCloudCostSpec'
- 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: (empty)
schema:
$ref: '#/definitions/v1AwsCloudCostSummary'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves AWS cloud account usage cost from cost explorer.
tags:
- clouds
/v1/clouds/aws/imageIds/{imageId}/volumeSize:
get:
description: Get AWS Volume Size
operationId: V1AwsVolumeSizeGet
parameters:
- description: Specific AWS Region
in: query
name: region
required: true
type: string
- description: Uid for the specific AWS cloud account
in: query
name: cloudAccountUid
required: true
type: string
- description: AWS image id
in: path
name: imageId
required: true
type: string
- 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: (empty)
schema:
$ref: '#/definitions/v1AwsVolumeSize'
security:
- ApiKey: []
- Authorization: []
summary: Get AWS Volume Size
tags:
- clouds
/v1/clouds/aws/policies:
post:
operationId: V1AwsIamPolicies
parameters:
- description: Request payload for AWS Cloud Account
in: body
name: account
required: true
schema:
$ref: '#/definitions/v1AwsCloudAccount'
- description: Uid for the specific AWS cloud account
in: query
name: cloudAccountUid
type: string
- 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: (empty)
schema:
$ref: '#/definitions/v1AwsPolicies'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a list of AWS policies for the specified account
tags:
- clouds
/v1/clouds/aws/policyArns/validate:
post:
operationId: V1AwsPolicyArnsValidate
parameters:
- description: Request payload to validate AWS policy ARN
in: body
name: spec
required: true
schema:
$ref: '#/definitions/v1AwsPolicyArnsSpec'
- description: Uid for the specific AWS cloud account
in: query
name: cloudAccountUid
type: string
- 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:
'204':
description: Ok response without content
headers:
AuditUid:
description: Audit uid for the request
type: string
security:
- ApiKey: []
- Authorization: []
summary: Validate the aws policy arns validate
tags:
- clouds
/v1/clouds/aws/properties/validate:
post:
operationId: V1AwsPropertiesValidate
parameters:
- description: Request payload for AWS properties validate spec
in: body
name: properties
required: true
schema:
$ref: '#/definitions/V1AwsPropertiesValidateSpec'
- 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:
'204':
description: Ok response without content
headers:
AuditUid:
description: Audit uid for the request
type: string
security:
- ApiKey: []
- Authorization: []
summary: Validate AWS properties
tags:
- clouds
/v1/clouds/aws/regions:
get:
operationId: V1AwsRegions
parameters:
- description: Uid for the specific AWS cloud account
in: query
name: cloudAccountUid
required: true
type: string
- 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: (empty)
schema:
$ref: '#/definitions/v1AwsRegions'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a list of AWS regions for the specified account
tags:
- clouds
/v1/clouds/aws/regions/{region}/availabilityzones:
get:
operationId: V1AwsZones
parameters:
- description: Region for which zones are requested
in: path
name: region
required: true
type: string
- description: Uid for the specific AWS cloud account
in: query
name: cloudAccountUid
required: true
type: string
- 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: (empty)
schema:
$ref: '#/definitions/v1AwsAvailabilityZones'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a list of AWS availability zones for the specified region
tags:
- clouds
/v1/clouds/aws/regions/{region}/copydefaultimages:
post:
operationId: V1AwsCopyImageFromDefaultRegion
parameters:
- description: Region to copy AWS image from
in: path
name: region
required: true
type: string
- description: Request payload to copy the AWS image
in: body
name: spectroClusterAwsImageTag
schema:
$ref: '#/definitions/v1AwsFindImageRequest'
- 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: (empty)
schema:
$ref: '#/definitions/v1AsyncOperationIdEntity'
security:
- ApiKey: []
- Authorization: []
summary: Copies the specified image from one region to another region
tags:
- clouds
/v1/clouds/aws/regions/{region}/eksClusters/name/validate:
get:
description: Returns no contents if aws cluster name is valid else error.
operationId: V1AwsClusterNameValidate
parameters:
- description: Uid for the specific AWS cloud account
in: query
name: cloudAccountUid
required: true
type: string
- description: cluster name to be validated
in: query
name: name
required: true
type: string
- description: Region for which cluster name is validated
in: path
name: region
required: true
type: string
- 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:
'204':
description: Ok response without content
headers:
AuditUid:
description: Audit uid for the request
type: string
security:
- ApiKey: []
- Authorization: []
summary: Check if Aws cluster name is valid
tags:
- clouds
/v1/clouds/aws/regions/{region}/images:
post:
operationId: V1AwsFindImage
parameters:
- description: Region to find AWS image
in: path
name: region
required: true
type: string
- description: Request payload to find the AWS image
in: body
name: awsImageRequest
schema:
$ref: '#/definitions/v1AwsFindImageRequest'
- 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: (empty)
schema:
$ref: '#/definitions/v1AwsImage'
security:
- ApiKey: []
- Authorization: []
summary: Returns AWS image for the specified AMI name
tags:
- clouds
/v1/clouds/aws/regions/{region}/instancetypes:
get:
operationId: V1AwsInstanceTypes
parameters:
- description: Region for which AWS instances are requested
in: path
name: region
required: true
type: string
- description: Filter for instances having cpu greater than or equal
format: double
in: query
name: cpuGtEq
type: number
- description: Filter for instances having memory greater than or equal
format: double
in: query
name: memoryGtEq
type: number
- description: Filter for instances having gpu greater than or equal
format: double
in: query
name: gpuGtEq
type: number
- description: Uid for the specific AWS cloud account
in: query
name: cloudAccountUid
type: string
- description: Optional HRG ARN to filter instance types by HRG supported families
in: query
name: hrgArn
pattern: ^arn:aws[a-z\-]*:resource-groups:[a-z0-9\-]+:[0-9]{12}:group/[a-zA-Z0-9\-_]+$
type: string
- 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: (empty)
schema:
$ref: '#/definitions/v1AwsInstanceTypes'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a list of AWS instance types
tags:
- clouds
/v1/clouds/aws/regions/{region}/keypairs:
get:
operationId: V1AwsKeyPairs
parameters:
- description: Region for which AWS key pairs are requested
in: path
name: region
required: true
type: string
- description: Uid for the specific AWS cloud account
in: query
name: cloudAccountUid
required: true
type: string
- 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: (empty)
schema:
$ref: '#/definitions/v1AwsKeyPairs'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a list of AWS keypairs
tags:
- clouds
/v1/clouds/aws/regions/{region}/keypairs/{keypair}/validate:
post:
operationId: V1AwsKeyPairValidate
parameters:
- description: Region for which AWS key pairs is validated
in: path
name: region
required: true
type: string
- description: Uid for the specific AWS cloud account
in: query
name: cloudAccountUid
required: true
type: string
- description: AWS Key pair which is to be validated
in: path
name: keypair
required: true
type: string
- 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:
'204':
description: Ok response without content
headers:
AuditUid:
description: Audit uid for the request
type: string
security:
- ApiKey: []
- Authorization: []
summary: Validate the specified AWS keypair
tags:
- clouds
/v1/clouds/aws/regions/{region}/kms/{keyId}:
get:
operationId: V1AwsKmsKeyGet
parameters:
- description: Region for which AWS KMS key belongs
in: path
name: region
required: true
type: string
- description: The globally unique identifier for the KMS key
in: path
name: keyId
required: true
type: string
- description: Uid for the specific AWS cloud account
in: query
name: cloudAccountUid
required: true
type: string
- 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: (empty)
schema:
$ref: '#/definitions/v1AwsKmsKeyEntity'
security:
- ApiKey: []
- Authorization: []
summary: Get AWS KMS key by Id
tags:
- clouds
/v1/clouds/aws/regions/{region}/kmskeys:
get:
operationId: V1AwsKmsKeys
parameters:
- description: Region for which AWS KMS key are requested
in: path
name: region
required: true
type: string
- description: Uid for the specific AWS cloud account
in: query
name: cloudAccountUid
required: true
type: string
- 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: (empty)
schema:
$ref: '#/definitions/v1AwsKmsKeys'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a list of AWS KMS keys for the specified account
tags:
- clouds
/v1/clouds/aws/regions/{region}/kmskeys/validate:
get:
operationId: V1AwsKmsKeyValidate
parameters:
- description: Region for which AWS KMS key is validated
in: path
name: region
required: true
type: string
- description: Uid for the specific AWS cloud account
in: query
name: cloudAccountUid
required: true
type: string
- description: AWS KEY ARN for validation
in: query
name: keyArn
required: true
type: string
- 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:
'204':
description: Ok response without content
headers:
AuditUid:
description: Audit uid for the request
type: string
security:
- ApiKey: []
- Authorization: []
summary: Validate an Aws KMS key for the specified account
tags:
- clouds
/v1/clouds/aws/regions/{region}/resourceGroups:
get:
operationId: V1AwsHostResourceGroups
parameters:
- description: AWS region
in: path
name: region
required: true
type: string
- description: UID of the AWS cloud account
in: query
name: cloudAccountUid
required: true
type: string
- 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: (empty)
schema:
$ref: '#/definitions/v1AwsHostResourceGroups'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a list of AWS Host Resource Groups for the specified account and region
tags:
- clouds
/v1/clouds/aws/regions/{region}/resourceGroups/licenses:
get:
operationId: V1AwsHostResourceGroupLicenses
parameters:
- description: AWS region
in: path
name: region
required: true
type: string
- description: UID of the AWS cloud account
in: query
name: cloudAccountUid
required: true
type: string
- description: ARN of the Host Resource Group
in: query
name: hrgArn
pattern: ^arn:aws[a-z\-]*:resource-groups:[a-z0-9\-]+:[0-9]{12}:group/[a-zA-Z0-9\-_]+$
required: true
type: string
- 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: (empty)
schema:
$ref: '#/definitions/v1AwsLicenseConfigurations'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves license configurations for the specified Host Resource Group
tags:
- clouds
/v1/clouds/aws/regions/{region}/resourceGroups/validateCapacity:
post:
operationId: V1AwsHostResourceGroupCapacityValidation
parameters:
- description: AWS region
in: path
name: region
required: true
type: string
- description: ARN of the Host Resource Group
in: query
name: hrgArn
pattern: ^arn:aws[a-z\-]*:resource-groups:[a-z0-9\-]+:[0-
# --- truncated at 32 KB (154 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/spectro-cloud/refs/heads/main/openapi/spectro-cloud-clouds-api-openapi.yml