Spectro Cloud cloudaccounts API
The cloudaccounts API from Spectro Cloud — 32 operation(s) for cloudaccounts.
The cloudaccounts API from Spectro Cloud — 32 operation(s) for cloudaccounts.
swagger: '2.0'
info:
title: Local Management APIs activations cloudaccounts API
version: v1
servers:
- url: https://edge-host-ip:5080
schemes:
- http
- https
consumes:
- application/json
produces:
- application/json
tags:
- name: cloudaccounts
x-displayName: Cloudaccounts
paths:
/v1/cloudaccounts/apache-cloudstack:
get:
operationId: v1CloudAccountsCloudStackList
parameters:
- description: 'Set of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.name'
in: query
name: fields
type: string
- description: 'Filters can be combined with AND, OR operators with field path name. Eg: metadata.name=TestServiceANDspec.cloudType=aws
Server will be restricted to certain fields based on the indexed data for each resource.'
in: query
name: filters
type: string
- description: 'Specify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1'
in: query
name: orderBy
type: string
- default: 50
description: 'limit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50.
If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results.'
format: int64
in: query
name: limit
type: integer
- description: offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.
format: int64
in: query
name: offset
type: integer
- description: continue token to paginate the subsequent data items
in: query
name: continue
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: An array of CloudStack cloud account items
schema:
$ref: '#/definitions/v1CloudStackAccounts'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a list of CloudStack cloud accounts
tags:
- cloudaccounts
x-Features:
- ApacheCloudstack
post:
operationId: v1CloudAccountsCloudStackCreate
parameters:
- description: Request payload to validate CloudStack cloud account
in: body
name: body
schema:
$ref: '#/definitions/v1CloudStackAccountInputEntity'
- 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:
'201':
description: Created successfully
headers:
AuditUid:
description: Audit uid for the request
type: string
schema:
$ref: '#/definitions/v1Uid'
security:
- ApiKey: []
- Authorization: []
summary: Creates a CloudStack cloud account
tags:
- cloudaccounts
x-Features:
- ApacheCloudstack
/v1/cloudaccounts/apache-cloudstack/{uid}:
parameters:
- description: CloudStack cloud account uid
in: path
name: uid
required: true
type: string
delete:
operationId: v1CloudAccountsCloudStackDelete
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:
'204':
description: The resource was deleted successfully
security:
- ApiKey: []
- Authorization: []
summary: Deletes the specified CloudStack account
tags:
- cloudaccounts
get:
operationId: v1CloudAccountsCloudStackGet
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/v1CloudStackAccount'
security:
- ApiKey: []
- Authorization: []
summary: Returns the specified CloudStack account
tags:
- cloudaccounts
put:
operationId: v1CloudAccountsCloudStackUpdate
parameters:
- in: body
name: body
schema:
$ref: '#/definitions/v1CloudStackAccountUpdateEntity'
- 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: The resource was updated successfully
security:
- ApiKey: []
- Authorization: []
summary: Updates the specified CloudStack account
tags:
- cloudaccounts
/v1/cloudaccounts/apache-cloudstack/{uid}/properties/diskofferings:
parameters:
- in: path
name: uid
required: true
type: string
get:
operationId: v1CloudstackAccountsUidDiskofferings
parameters:
- 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: Get the cloudstack disk offerings for a given account and zone
tags:
- cloudaccounts
/v1/cloudaccounts/apache-cloudstack/{uid}/properties/domains:
parameters:
- in: path
name: uid
required: true
type: string
get:
operationId: v1CloudstackAccountsUidDomains
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/v1CloudStackDomains'
security:
- ApiKey: []
- Authorization: []
summary: Get the cloudstack domains for a given account
tags:
- cloudaccounts
/v1/cloudaccounts/apache-cloudstack/{uid}/properties/keypairs:
parameters:
- in: path
name: uid
required: true
type: string
get:
operationId: v1CloudstackAccountsUidKeypairs
parameters:
- 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: Get the cloudstack SSH key pairs for a given account
tags:
- cloudaccounts
/v1/cloudaccounts/apache-cloudstack/{uid}/properties/networks:
parameters:
- in: path
name: uid
required: true
type: string
get:
operationId: v1CloudstackAccountsUidNetworks
parameters:
- 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: Get the cloudstack networks for a given account and zone
tags:
- cloudaccounts
/v1/cloudaccounts/apache-cloudstack/{uid}/properties/offerings:
parameters:
- in: path
name: uid
required: true
type: string
get:
operationId: v1CloudstackAccountsUidOfferings
parameters:
- 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: Get the cloudstack compute offerings for a given account and zone
tags:
- cloudaccounts
/v1/cloudaccounts/apache-cloudstack/{uid}/properties/projects:
parameters:
- in: path
name: uid
required: true
type: string
get:
operationId: v1CloudstackAccountsUidProjects
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/v1CloudStackProjects'
security:
- ApiKey: []
- Authorization: []
summary: Get the cloudstack projects for a given account and domain
tags:
- cloudaccounts
/v1/cloudaccounts/apache-cloudstack/{uid}/properties/templates:
parameters:
- in: path
name: uid
required: true
type: string
get:
operationId: v1CloudstackAccountsUidTemplates
parameters:
- 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: Get the cloudstack templates for a given account and zone
tags:
- cloudaccounts
/v1/cloudaccounts/apache-cloudstack/{uid}/properties/vpcs:
parameters:
- in: path
name: uid
required: true
type: string
get:
operationId: v1CloudstackAccountsUidVpcs
parameters:
- 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: Get the cloudstack VPCs for a given account
tags:
- cloudaccounts
/v1/cloudaccounts/apache-cloudstack/{uid}/properties/zones:
parameters:
- in: path
name: uid
required: true
type: string
get:
operationId: v1CloudstackAccountsUidZones
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/v1CloudStackZones'
security:
- ApiKey: []
- Authorization: []
summary: Get the cloudstack zones for a given account
tags:
- cloudaccounts
/v1/cloudaccounts/aws:
get:
operationId: v1CloudAccountsAwsList
parameters:
- description: 'Set of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.name'
in: query
name: fields
type: string
- description: 'Filters can be combined with AND, OR operators with field path name. Eg: metadata.name=TestServiceANDspec.cloudType=aws
Server will be restricted to certain fields based on the indexed data for each resource.'
in: query
name: filters
type: string
- description: 'Specify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1'
in: query
name: orderBy
type: string
- default: 50
description: 'limit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50.
If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results.'
format: int64
in: query
name: limit
type: integer
- description: offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.
format: int64
in: query
name: offset
type: integer
- description: continue token to paginate the subsequent data items
in: query
name: continue
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: An array of cloud account items
schema:
$ref: '#/definitions/v1AwsAccounts'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a list of AWS cloud accounts
tags:
- cloudaccounts
post:
operationId: v1CloudAccountsAwsCreate
parameters:
- description: Request payload to validate AWS cloud account
in: body
name: body
schema:
$ref: '#/definitions/v1AwsAccount'
- 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:
'201':
description: Created successfully
headers:
AuditUid:
description: Audit uid for the request
type: string
schema:
$ref: '#/definitions/v1Uid'
security:
- ApiKey: []
- Authorization: []
summary: Creates an AWS cloud account
tags:
- cloudaccounts
/v1/cloudaccounts/aws/{uid}:
parameters:
- description: AWS cloud account uid
in: path
name: uid
required: true
type: string
delete:
operationId: v1CloudAccountsAwsDelete
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:
'204':
description: The resource was deleted successfully
security:
- ApiKey: []
- Authorization: []
summary: Deletes the specified AWS account
tags:
- cloudaccounts
get:
operationId: v1CloudAccountsAwsGet
parameters:
- default: false
in: query
name: assumeCredentials
type: boolean
- 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/v1AwsAccount'
security:
- ApiKey: []
- Authorization: []
summary: Returns the specified AWS account
tags:
- cloudaccounts
put:
operationId: v1CloudAccountsAwsUpdate
parameters:
- in: body
name: body
schema:
$ref: '#/definitions/v1AwsAccount'
- 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: The resource was updated successfully
security:
- ApiKey: []
- Authorization: []
summary: Updates the specified AWS account
tags:
- cloudaccounts
/v1/cloudaccounts/azure:
get:
operationId: v1CloudAccountsAzureList
parameters:
- description: 'Set of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.name'
in: query
name: fields
type: string
- description: 'Filters can be combined with AND, OR operators with field path name. Eg: metadata.name=TestServiceANDspec.cloudType=aws
Server will be restricted to certain fields based on the indexed data for each resource.'
in: query
name: filters
type: string
- description: 'Specify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1'
in: query
name: orderBy
type: string
- default: 50
description: 'limit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50.
If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results.'
format: int64
in: query
name: limit
type: integer
- description: offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.
format: int64
in: query
name: offset
type: integer
- description: continue token to paginate the subsequent data items
in: query
name: continue
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: An array of azure cloud account items
schema:
$ref: '#/definitions/v1AzureAccounts'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a list of azure cloud accounts
tags:
- cloudaccounts
post:
operationId: v1CloudAccountsAzureCreate
parameters:
- description: Request payload to validate Azure cloud account
in: body
name: body
schema:
$ref: '#/definitions/v1AzureAccount'
- 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:
'201':
description: Created successfully
headers:
AuditUid:
description: Audit uid for the request
type: string
schema:
$ref: '#/definitions/v1Uid'
security:
- ApiKey: []
- Authorization: []
summary: Create azure cloud account
tags:
- cloudaccounts
/v1/cloudaccounts/azure/{uid}:
parameters:
- description: Azure cloud account uid
in: path
name: uid
required: true
type: string
delete:
operationId: v1CloudAccountsAzureDelete
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:
'204':
description: The resource was deleted successfully
security:
- ApiKey: []
- Authorization: []
summary: Deletes the specified azure account
tags:
- cloudaccounts
get:
operationId: v1CloudAccountsAzureGet
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/v1AzureAccount'
security:
- ApiKey: []
- Authorization: []
summary: Returns the specified azure cloud account
tags:
- cloudaccounts
put:
operationId: v1CloudAccountsAzureUpdate
parameters:
- in: body
name: body
schema:
$ref: '#/definitions/v1AzureAccount'
- 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: The resource was updated successfully
security:
- ApiKey: []
- Authorization: []
summary: Updates the specified azure account
tags:
- cloudaccounts
/v1/cloudaccounts/cloudTypes/{cloudType}:
parameters:
- description: Custom cloud type
in: path
name: cloudType
required: true
type: string
get:
operationId: v1CloudAccountsCustomList
parameters:
- description: 'Set of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.name'
in: query
name: fields
type: string
- description: 'Filters can be combined with AND, OR operators with field path name. Eg: metadata.name=TestServiceANDspec.cloudType=aws
Server will be restricted to certain fields based on the indexed data for each resource.'
in: query
name: filters
type: string
- description: 'Specify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1'
in: query
name: orderBy
type: string
- default: 50
description: 'limit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50.
If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results.'
format: int64
in: query
name: limit
type: integer
- description: offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.
format: int64
in: query
name: offset
type: integer
- description: continue token to paginate the subsequent data items
in: query
name: continue
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: An array of cloud account by specified cloud type items
schema:
$ref: '#/definitions/v1CustomAccounts'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a list of cloud accounts by cloud type
tags:
- cloudaccounts
post:
operationId: v1CloudAccountsCustomCreate
parameters:
- description: Request payload to validate Custom cloud account
in: body
name: body
schema:
$ref: '#/definitions/v1CustomAccountEntity'
- 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:
'201':
description: Created successfully
headers:
AuditUid:
description: Audit uid for the request
type: string
schema:
$ref: '#/definitions/v1Uid'
security:
- ApiKey: []
- Authorization: []
summary: Creates an cloud account of specific cloud type
tags:
- cloudaccounts
/v1/cloudaccounts/cloudTypes/{cloudType}/{uid}:
parameters:
- description: Custom cloud account uid
in: path
name: uid
required: true
type: string
- description: Custom cloud type
in: path
name: cloudType
required: true
type: string
delete:
operationId: v1CloudAccountsCustomDelete
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:
'204':
description: The resource was deleted successfully
security:
- ApiKey: []
- Authorization: []
summary: Deletes the specified account by cloud type
tags:
- cloudaccounts
get:
operationId: v1CloudAccountsCustomGet
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/v1CustomAccount'
security:
- ApiKey: []
- Authorization: []
summary: Returns the specified account by cloud type
tags:
- cloudaccounts
put:
operationId: v1CloudAccountsCustomUpdate
parameters:
- in: body
name: body
schema:
$ref: '#/definitions/v1CustomAccountEntity'
- 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: The resource was updated successfully
security:
- ApiKey: []
- Authorization: []
summary: Updates the specified account by cloud type
tags:
- cloudaccounts
/v1/cloudaccounts/gcp:
get:
operationId: v1CloudAccountsGcpList
parameters:
- description: 'Set of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.name'
in: query
name: fields
type: string
- description: 'Filters can be combined with AND, OR operators with field path name. Eg: metadata.name=TestServiceANDspec.cloudType=aws
Server will be restricted to certain fields based on the indexed data for each resource.'
in: query
name: filters
type: string
- description: 'Specify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1'
in: query
name: orderBy
type: string
- default: 50
description: 'limit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50.
If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results.'
format: int64
in: query
name: limit
type: integer
- description: offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.
format: int64
in: query
name: offset
type: integer
- description: continue token to paginate the subsequent data items
in: query
name: continue
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: An array of gcp cloud account items
schema:
$ref: '#/definitions/v1GcpAccounts'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a list of gcp cloud accounts
tags:
- cloudaccounts
post:
operationId: v1CloudAccountsGcpCreate
parameters:
- description: Request payload to validate GCP cloud account
in: body
name: body
schema:
$ref: '#/definitions/v1GcpAccountEntity'
- 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:
'201':
description: Created successfully
headers:
AuditUid:
description: Audit uid for the request
type: string
schema:
$ref: '#/definitions/v1Uid'
security:
- ApiKey: []
- Authorization: []
summary: Creates a GCP cloud account
tags:
- cloudaccounts
/v1/cloudaccounts/gcp/{uid}:
parameters:
- description: GCP cloud account uid
in: path
name: uid
required: true
type: string
delete:
operationId: v1CloudAccountsGcpDelete
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:
'204':
description: The resource was deleted successfully
security:
- ApiKey: []
- Authorization: []
summary: Deletes the specified GCP account
tags:
- cloudaccounts
get:
operationId: v1CloudAccountsGcpGet
parameters:
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
# --- truncated at 32 KB (85 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/spectro-cloud/refs/heads/main/openapi/spectro-cloud-cloudaccounts-api-openapi.yml