Cloud Accounts

→

https://api.spectrocloud.com/v1/cloudaccounts/aws

summary:

Retrieves a list of AWS cloud accounts

Parameters:

Name	Type	Description	Required
fields	string	Set of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.name	no
filters	string	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.	no
orderBy	string	Specify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1	no
limit	integer	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.	no
offset	integer	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.	no
continue	string	continue token to paginate the subsequent data items	no

HTTP code: 200
Description: An array of cloud account items
Response body:

{
  "items": [
    {
      "apiVersion": "string",
      "kind": "string",
      "metadata": {
        "annotations": "object",
        "creationTimestamp": "date-time",
        "deletionTimestamp": "date-time",
        "labels": "object",
        "lastModifiedTimestamp": "date-time",
        "name": "string",
        "namespace": "string",
        "resourceVersion": "string",
        "selfLink": "string",
        "uid": "string"
      },
      "spec": {
        "accessKey": "string",
        "credentialType": "string",
        "policyARNs": [
          "string"
        ],
        "secretKey": "string",
        "settings": {
          "disablePropertiesRequest": "boolean"
        },
        "sts": {
          "arn": "string",
          "externalId": "string"
        }
      },
      "status": {
        "state": "string"
      }
    }
  ],
  "listmeta": {
    "continue": "string",
    "count": "integer",
    "limit": "integer",
    "offset": "integer"
  }
}

→

https://api.spectrocloud.com/v1/cloudaccounts/aws

summary:

Creates an AWS cloud account

Body

{
  "apiVersion": "string",
  "kind": "string",
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "accessKey": "string",
    "credentialType": "string",
    "policyARNs": [
      "string"
    ],
    "secretKey": "string",
    "settings": {
      "disablePropertiesRequest": "boolean"
    },
    "sts": {
      "arn": "string",
      "externalId": "string"
    }
  },
  "status": {
    "state": "string"
  }
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

https://api.spectrocloud.com/v1/cloudaccounts/aws/{uid}

summary:

Deletes the specified AWS account

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 204
Description: The resource was deleted successfully

→

https://api.spectrocloud.com/v1/cloudaccounts/aws/{uid}

summary:

Returns the specified AWS account

Parameters:

Name	Type	Description	Required
assumeCredentials	boolean		no

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 200
Description: OK
Response body:

{
  "apiVersion": "string",
  "kind": "string",
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "accessKey": "string",
    "credentialType": "string",
    "policyARNs": [
      "string"
    ],
    "secretKey": "string",
    "settings": {
      "disablePropertiesRequest": "boolean"
    },
    "sts": {
      "arn": "string",
      "externalId": "string"
    }
  },
  "status": {
    "state": "string"
  }
}

→

https://api.spectrocloud.com/v1/cloudaccounts/aws/{uid}

summary:

Updates the specified AWS account

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "apiVersion": "string",
  "kind": "string",
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "accessKey": "string",
    "credentialType": "string",
    "policyARNs": [
      "string"
    ],
    "secretKey": "string",
    "settings": {
      "disablePropertiesRequest": "boolean"
    },
    "sts": {
      "arn": "string",
      "externalId": "string"
    }
  },
  "status": {
    "state": "string"
  }
}

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/cloudaccounts/azure

summary:

Retrieves a list of azure cloud accounts

Parameters:

Name	Type	Description	Required
fields	string	Set of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.name	no
filters	string	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.	no
orderBy	string	Specify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1	no
limit	integer	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.	no
offset	integer	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.	no
continue	string	continue token to paginate the subsequent data items	no

HTTP code: 200
Description: An array of azure cloud account items
Response body:

{
  "items": [
    {
      "apiVersion": "string",
      "kind": "string",
      "metadata": {
        "annotations": "object",
        "creationTimestamp": "date-time",
        "deletionTimestamp": "date-time",
        "labels": "object",
        "lastModifiedTimestamp": "date-time",
        "name": "string",
        "namespace": "string",
        "resourceVersion": "string",
        "selfLink": "string",
        "uid": "string"
      },
      "spec": {
        "clientId": "string",
        "clientSecret": "string",
        "settings": {
          "disablePropertiesRequest": "boolean"
        },
        "tenantId": "string",
        "tenantName": "string"
      },
      "status": {
        "state": "string"
      }
    }
  ],
  "listmeta": {
    "continue": "string",
    "count": "integer",
    "limit": "integer",
    "offset": "integer"
  }
}

→

https://api.spectrocloud.com/v1/cloudaccounts/azure

summary:

Create azure cloud account

Body

{
  "apiVersion": "string",
  "kind": "string",
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "clientId": "string",
    "clientSecret": "string",
    "settings": {
      "disablePropertiesRequest": "boolean"
    },
    "tenantId": "string",
    "tenantName": "string"
  },
  "status": {
    "state": "string"
  }
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

https://api.spectrocloud.com/v1/cloudaccounts/azure/{uid}

summary:

Deletes the specified azure account

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 204
Description: The resource was deleted successfully

→

https://api.spectrocloud.com/v1/cloudaccounts/azure/{uid}

summary:

Returns the specified azure cloud account

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 200
Description: OK
Response body:

{
  "apiVersion": "string",
  "kind": "string",
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "clientId": "string",
    "clientSecret": "string",
    "settings": {
      "disablePropertiesRequest": "boolean"
    },
    "tenantId": "string",
    "tenantName": "string"
  },
  "status": {
    "state": "string"
  }
}

→

https://api.spectrocloud.com/v1/cloudaccounts/azure/{uid}

summary:

Updates the specified azure account

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "apiVersion": "string",
  "kind": "string",
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "clientId": "string",
    "clientSecret": "string",
    "settings": {
      "disablePropertiesRequest": "boolean"
    },
    "tenantId": "string",
    "tenantName": "string"
  },
  "status": {
    "state": "string"
  }
}

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/cloudaccounts/coxedge

summary:

Retrieves a list of CoxEdge cloud accounts

Parameters:

Name	Type	Description	Required
fields	string	Set of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.name	no
filters	string	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.	no
orderBy	string	Specify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1	no
limit	integer	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.	no
offset	integer	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.	no
continue	string	continue token to paginate the subsequent data items	no

HTTP code: 200
Description: An array of cloud account items
Response body:

{
  "items": [
    {
      "apiVersion": "string",
      "kind": "string",
      "metadata": {
        "annotations": "object",
        "creationTimestamp": "date-time",
        "deletionTimestamp": "date-time",
        "labels": "object",
        "lastModifiedTimestamp": "date-time",
        "name": "string",
        "namespace": "string",
        "resourceVersion": "string",
        "selfLink": "string",
        "uid": "string"
      },
      "spec": {
        "apiBaseUrl": "string",
        "apiKey": "string",
        "environment": "string",
        "organizationId": "string",
        "service": "string"
      },
      "status": {
        "state": "string"
      }
    }
  ],
  "listmeta": {
    "continue": "string",
    "count": "integer",
    "limit": "integer",
    "offset": "integer"
  }
}

→

https://api.spectrocloud.com/v1/cloudaccounts/coxedge

summary:

Creates an CoxEdge cloud account

Body

{
  "apiVersion": "string",
  "kind": "string",
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "apiBaseUrl": "string",
    "apiKey": "string",
    "environment": "string",
    "organizationId": "string",
    "service": "string"
  },
  "status": {
    "state": "string"
  }
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

https://api.spectrocloud.com/v1/cloudaccounts/coxedge/{uid}

summary:

Deletes the specified CoxEdge account

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 204
Description: The resource was deleted successfully

→

https://api.spectrocloud.com/v1/cloudaccounts/coxedge/{uid}

summary:

Returns the specified CoxEdge account

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 200
Description: OK
Response body:

{
  "apiVersion": "string",
  "kind": "string",
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "apiBaseUrl": "string",
    "apiKey": "string",
    "environment": "string",
    "organizationId": "string",
    "service": "string"
  },
  "status": {
    "state": "string"
  }
}

→

https://api.spectrocloud.com/v1/cloudaccounts/coxedge/{uid}

summary:

Updates the specified CoxEdge account

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "apiVersion": "string",
  "kind": "string",
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "apiBaseUrl": "string",
    "apiKey": "string",
    "environment": "string",
    "organizationId": "string",
    "service": "string"
  },
  "status": {
    "state": "string"
  }
}

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/cloudaccounts/gcp

summary:

Retrieves a list of gcp cloud accounts

Parameters:

Name	Type	Description	Required
fields	string	Set of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.name	no
filters	string	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.	no
orderBy	string	Specify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1	no
limit	integer	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.	no
offset	integer	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.	no
continue	string	continue token to paginate the subsequent data items	no

HTTP code: 200
Description: An array of gcp cloud account items
Response body:

{
  "items": [
    {
      "apiVersion": "string",
      "kind": "string",
      "metadata": {
        "annotations": "object",
        "creationTimestamp": "date-time",
        "deletionTimestamp": "date-time",
        "labels": "object",
        "lastModifiedTimestamp": "date-time",
        "name": "string",
        "namespace": "string",
        "resourceVersion": "string",
        "selfLink": "string",
        "uid": "string"
      },
      "spec": {
        "jsonCredentials": "string",
        "jsonCredentialsFileName": "string"
      },
      "status": {
        "state": "string"
      }
    }
  ],
  "listmeta": {
    "continue": "string",
    "count": "integer",
    "limit": "integer",
    "offset": "integer"
  }
}

→

https://api.spectrocloud.com/v1/cloudaccounts/gcp

summary:

Creates a GCP cloud account

Body

{
  "apiVersion": "string",
  "kind": "string",
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "jsonCredentials": "string",
    "jsonCredentialsFileUid": "string"
  },
  "status": {
    "state": "string"
  }
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

https://api.spectrocloud.com/v1/cloudaccounts/gcp/{uid}

summary:

Deletes the specified GCP account

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 204
Description: The resource was deleted successfully

→

https://api.spectrocloud.com/v1/cloudaccounts/gcp/{uid}

summary:

Returns the specified GCP cloud account

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 200
Description: OK
Response body:

{
  "apiVersion": "string",
  "kind": "string",
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "jsonCredentials": "string",
    "jsonCredentialsFileName": "string"
  },
  "status": {
    "state": "string"
  }
}

→

https://api.spectrocloud.com/v1/cloudaccounts/gcp/{uid}

summary:

Updates the specified GCP account

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "apiVersion": "string",
  "kind": "string",
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "jsonCredentials": "string",
    "jsonCredentialsFileUid": "string"
  },
  "status": {
    "state": "string"
  }
}

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/cloudaccounts/maas

summary:

Retrieves a list of Maas cloud accounts

Parameters:

Name	Type	Description	Required
fields	string	Set of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.name	no
filters	string	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.	no
orderBy	string	Specify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1	no
limit	integer	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.	no
offset	integer	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.	no
continue	string	continue token to paginate the subsequent data items	no

HTTP code: 200
Description: An array of cloud account items
Response body:

{
  "items": [
    {
      "apiVersion": "string",
      "kind": "string",
      "metadata": {
        "annotations": "object",
        "creationTimestamp": "date-time",
        "deletionTimestamp": "date-time",
        "labels": "object",
        "lastModifiedTimestamp": "date-time",
        "name": "string",
        "namespace": "string",
        "resourceVersion": "string",
        "selfLink": "string",
        "uid": "string"
      },
      "spec": {
        "apiEndpoint": "string",
        "apiKey": "string",
        "preferredSubnets": [
          "string"
        ]
      },
      "status": {
        "state": "string"
      }
    }
  ],
  "listmeta": {
    "continue": "string",
    "count": "integer",
    "limit": "integer",
    "offset": "integer"
  }
}

→

https://api.spectrocloud.com/v1/cloudaccounts/maas

summary:

Creates an Maas cloud account

Body

{
  "apiVersion": "string",
  "kind": "string",
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "apiEndpoint": "string",
    "apiKey": "string",
    "preferredSubnets": [
      "string"
    ]
  },
  "status": {
    "state": "string"
  }
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

https://api.spectrocloud.com/v1/cloudaccounts/maas/{uid}

summary:

Deletes the specified Maas account

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 204
Description: The resource was deleted successfully

→

https://api.spectrocloud.com/v1/cloudaccounts/maas/{uid}

summary:

Returns the specified Maas account

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 200
Description: OK
Response body:

{
  "apiVersion": "string",
  "kind": "string",
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "apiEndpoint": "string",
    "apiKey": "string",
    "preferredSubnets": [
      "string"
    ]
  },
  "status": {
    "state": "string"
  }
}

→

https://api.spectrocloud.com/v1/cloudaccounts/maas/{uid}

summary:

Patches the specified CloudAccount Maas

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "items": {
    "from": "string",
    "op": "string",
    "path": "string",
    "value": "object"
  }
}

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/cloudaccounts/maas/{uid}

summary:

Updates the specified Maas account

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "apiVersion": "string",
  "kind": "string",
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "apiEndpoint": "string",
    "apiKey": "string",
    "preferredSubnets": [
      "string"
    ]
  },
  "status": {
    "state": "string"
  }
}

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/cloudaccounts/maas/{uid}/properties/azs

summary:

Get the maas azs for a given account

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 200
Description: (empty)
Response body:

{
  "items": [
    {
      "description": "string",
      "name": "string"
    }
  ]
}

→

https://api.spectrocloud.com/v1/cloudaccounts/maas/{uid}/properties/domains

summary:

Get the maas domains for a given account

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 200
Description: (empty)
Response body:

{
  "items": [
    {
      "name": "string"
    }
  ]
}

→

https://api.spectrocloud.com/v1/cloudaccounts/maas/{uid}/properties/resourcePools

summary:

Get the maas pools for a given account

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 200
Description: (empty)
Response body:

{
  "items": [
    {
      "description": "string",
      "name": "string"
    }
  ]
}

→

https://api.spectrocloud.com/v1/cloudaccounts/maas/{uid}/properties/subnets

summary:

Get the maas subnets for a given account

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 200
Description: (empty)
Response body:

{
  "items": [
    {
      "id": "integer",
      "name": "string",
      "space": "string",
      "vlans": {
        "fabric": "string",
        "id": "integer",
        "name": "string"
      }
    }
  ]
}

→

https://api.spectrocloud.com/v1/cloudaccounts/openstack

summary:

Retrieves a list of OpenStack cloud accounts

Parameters:

Name	Type	Description	Required
fields	string	Set of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.name	no
filters	string	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.	no
orderBy	string	Specify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1	no
limit	integer	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.	no
offset	integer	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.	no
continue	string	continue token to paginate the subsequent data items	no

HTTP code: 200
Description: An array of cloud account items
Response body:

{
  "items": [
    {
      "apiVersion": "string",
      "kind": "string",
      "metadata": {
        "annotations": "object",
        "creationTimestamp": "date-time",
        "deletionTimestamp": "date-time",
        "labels": "object",
        "lastModifiedTimestamp": "date-time",
        "name": "string",
        "namespace": "string",
        "resourceVersion": "string",
        "selfLink": "string",
        "uid": "string"
      },
      "spec": {
        "caCert": "string",
        "defaultDomain": "string",
        "defaultProject": "string",
        "identityEndpoint": "string",
        "insecure": "boolean",
        "parentRegion": "string",
        "password": "string",
        "username": "string"
      },
      "status": {
        "state": "string"
      }
    }
  ],
  "listmeta": {
    "continue": "string",
    "count": "integer",
    "limit": "integer",
    "offset": "integer"
  }
}

→

https://api.spectrocloud.com/v1/cloudaccounts/openstack

summary:

Creates a OpenStack cloud account

Body

{
  "apiVersion": "string",
  "kind": "string",
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "caCert": "string",
    "defaultDomain": "string",
    "defaultProject": "string",
    "identityEndpoint": "string",
    "insecure": "boolean",
    "parentRegion": "string",
    "password": "string",
    "username": "string"
  },
  "status": {
    "state": "string"
  }
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

https://api.spectrocloud.com/v1/cloudaccounts/openstack/{uid}

summary:

Deletes the specified OpenStack account

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 204
Description: The resource was deleted successfully

→

https://api.spectrocloud.com/v1/cloudaccounts/openstack/{uid}

summary:

Returns the specified OpenStack account

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 200
Description: OK
Response body:

{
  "apiVersion": "string",
  "kind": "string",
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "caCert": "string",
    "defaultDomain": "string",
    "defaultProject": "string",
    "identityEndpoint": "string",
    "insecure": "boolean",
    "parentRegion": "string",
    "password": "string",
    "username": "string"
  },
  "status": {
    "state": "string"
  }
}

→

https://api.spectrocloud.com/v1/cloudaccounts/openstack/{uid}

summary:

Updates the specified OpenStack account

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "apiVersion": "string",
  "kind": "string",
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "caCert": "string",
    "defaultDomain": "string",
    "defaultProject": "string",
    "identityEndpoint": "string",
    "insecure": "boolean",
    "parentRegion": "string",
    "password": "string",
    "username": "string"
  },
  "status": {
    "state": "string"
  }
}

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/cloudaccounts/openstack/{uid}/properties/azs

summary:

Get the openstack azs for a given account and region

Parameters:

Name	Type	Required
region	string	no
project	string	no
domain	string	no

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 200
Description: (empty)
Response body:

{
  "azs": [
    {
      "name": "string"
    }
  ]
}

→

https://api.spectrocloud.com/v1/cloudaccounts/openstack/{uid}/properties/flavors

summary:

Get the openstack keypairs for a given account and scope

Parameters:

Name	Type	Required
project	string	no
region	string	no
domain	string	no

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 200
Description: (empty)
Response body:

{
  "items": [
    {
      "disk": "integer",
      "ephemeral": "integer",
      "id": "string",
      "memory": "integer",
      "name": "string",
      "vcpus": "integer"
    }
  ]
}

→

https://api.spectrocloud.com/v1/cloudaccounts/openstack/{uid}/properties/keypairs

summary:

Get the openstack keypairs for a given account and scope

Parameters:

Name	Type	Required
project	string	no
region	string	no
domain	string	no

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 200
Description: (empty)
Response body:

{
  "items": [
    {
      "name": "string",
      "publicKey": "string"
    }
  ]
}

→

https://api.spectrocloud.com/v1/cloudaccounts/openstack/{uid}/properties/networks

summary:

Get the openstack networks for a given account and scope

Parameters:

Name	Type	Required
project	string	no
region	string	no
domain	string	no

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 200
Description: (empty)
Response body:

{
  "items": [
    {
      "description": "string",
      "id": "string",
      "name": "string",
      "subnets": [
        {
          "description": "string",
          "id": "string",
          "name": "string"
        }
      ]
    }
  ]
}

→

https://api.spectrocloud.com/v1/cloudaccounts/openstack/{uid}/properties/projects

summary:

Get the openstack projects for a given account

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 200
Description: (empty)
Response body:

{
  "items": [
    {
      "description": "string",
      "domainId": "string",
      "id": "string",
      "name": "string",
      "parentProjectId": "string"
    }
  ]
}

→

https://api.spectrocloud.com/v1/cloudaccounts/openstack/{uid}/properties/regions

summary:

Get the openstack regions for a given account

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 200
Description: (empty)
Response body:

{
  "domains": [
    {
      "description": "string",
      "id": "string",
      "name": "string"
    }
  ],
  "regions": [
    {
      "description": "string",
      "id": "string",
      "parentRegionId": "string"
    }
  ]
}

→

https://api.spectrocloud.com/v1/cloudaccounts/summary

summary:

Retrieves a list of cloud accounts summary

Parameters:

Name	Type	Description	Required
filters	string	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.	no
orderBy	string	Specify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1	no
limit	integer	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.	no
offset	integer	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.	no
continue	string	continue token to paginate the subsequent data items	no

HTTP code: 200
Description: An array of cloud account summary items
Response body:

{
  "items": [
    {
      "kind": "string",
      "metadata": {
        "annotations": "object",
        "creationTimestamp": "date-time",
        "deletionTimestamp": "date-time",
        "labels": "object",
        "lastModifiedTimestamp": "date-time",
        "name": "string",
        "namespace": "string",
        "resourceVersion": "string",
        "selfLink": "string",
        "uid": "string"
      },
      "specSummary": {
        "accountId": "string"
      },
      "status": {
        "state": "string"
      }
    }
  ],
  "listmeta": {
    "continue": "string",
    "count": "integer",
    "limit": "integer",
    "offset": "integer"
  }
}

→

https://api.spectrocloud.com/v1/cloudaccounts/tencent

summary:

Retrieves a list of Tencent cloud accounts

Parameters:

Name	Type	Description	Required
fields	string	Set of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.name	no
filters	string	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.	no
orderBy	string	Specify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1	no
limit	integer	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.	no
offset	integer	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.	no
continue	string	continue token to paginate the subsequent data items	no

HTTP code: 200
Description: An array of cloud account items
Response body:

{
  "items": [
    {
      "apiVersion": "string",
      "kind": "string",
      "metadata": {
        "annotations": "object",
        "creationTimestamp": "date-time",
        "deletionTimestamp": "date-time",
        "labels": "object",
        "lastModifiedTimestamp": "date-time",
        "name": "string",
        "namespace": "string",
        "resourceVersion": "string",
        "selfLink": "string",
        "uid": "string"
      },
      "spec": {
        "secretId": "string",
        "secretKey": "string"
      },
      "status": {
        "state": "string"
      }
    }
  ],
  "listmeta": {
    "continue": "string",
    "count": "integer",
    "limit": "integer",
    "offset": "integer"
  }
}

→

https://api.spectrocloud.com/v1/cloudaccounts/tencent

summary:

Creates an Tencent cloud account

Body

{
  "apiVersion": "string",
  "kind": "string",
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "secretId": "string",
    "secretKey": "string"
  },
  "status": {
    "state": "string"
  }
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

https://api.spectrocloud.com/v1/cloudaccounts/tencent/{uid}

summary:

Deletes the specified Tencent account

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 204
Description: The resource was deleted successfully

→

https://api.spectrocloud.com/v1/cloudaccounts/tencent/{uid}

summary:

Returns the specified Tencent account

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 200
Description: OK
Response body:

{
  "apiVersion": "string",
  "kind": "string",
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "secretId": "string",
    "secretKey": "string"
  },
  "status": {
    "state": "string"
  }
}

→

https://api.spectrocloud.com/v1/cloudaccounts/tencent/{uid}

summary:

Updates the specified Tencent account

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "apiVersion": "string",
  "kind": "string",
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "secretId": "string",
    "secretKey": "string"
  },
  "status": {
    "state": "string"
  }
}

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/cloudaccounts/vsphere

summary:

Retrieves a list of vSphere cloud accounts

Parameters:

Name	Type	Description	Required
fields	string	Set of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.name	no
filters	string	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.	no
orderBy	string	Specify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1	no
limit	integer	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.	no
offset	integer	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.	no
continue	string	continue token to paginate the subsequent data items	no

HTTP code: 200
Description: An array of cloud account items
Response body:

{
  "items": [
    {
      "apiVersion": "string",
      "kind": "string",
      "metadata": {
        "annotations": "object",
        "creationTimestamp": "date-time",
        "deletionTimestamp": "date-time",
        "labels": "object",
        "lastModifiedTimestamp": "date-time",
        "name": "string",
        "namespace": "string",
        "resourceVersion": "string",
        "selfLink": "string",
        "uid": "string"
      },
      "spec": {
        "insecure": "boolean",
        "password": "string",
        "username": "string",
        "vcenterServer": "string"
      },
      "status": {
        "state": "string"
      }
    }
  ],
  "listmeta": {
    "continue": "string",
    "count": "integer",
    "limit": "integer",
    "offset": "integer"
  }
}

→

https://api.spectrocloud.com/v1/cloudaccounts/vsphere

summary:

Creates a vSphere cloud account

Body

{
  "apiVersion": "string",
  "kind": "string",
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "insecure": "boolean",
    "password": "string",
    "username": "string",
    "vcenterServer": "string"
  },
  "status": {
    "state": "string"
  }
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

https://api.spectrocloud.com/v1/cloudaccounts/vsphere/{uid}

summary:

Deletes the specified vSphere account

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 204
Description: The resource was deleted successfully

→

https://api.spectrocloud.com/v1/cloudaccounts/vsphere/{uid}

summary:

Returns the specified vSphere account

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 200
Description: OK
Response body:

{
  "apiVersion": "string",
  "kind": "string",
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "insecure": "boolean",
    "password": "string",
    "username": "string",
    "vcenterServer": "string"
  },
  "status": {
    "state": "string"
  }
}

→

https://api.spectrocloud.com/v1/cloudaccounts/vsphere/{uid}

summary:

Updates the specified VSphere account

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "apiVersion": "string",
  "kind": "string",
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "insecure": "boolean",
    "password": "string",
    "username": "string",
    "vcenterServer": "string"
  },
  "status": {
    "state": "string"
  }
}

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/cloudaccounts/vsphere/{uid}/properties/computecluster/resources

summary:

Get the vSphere computecluster resources for the given overlord account

Path parameters:

Name	Type	Required
uid	string	yes
datacenter	string	yes
computecluster	string	yes

HTTP code: 200
Description: (empty)
Response body:

{
  "computecluster": {
    "datastores": [
      "string"
    ],
    "name": "string",
    "networks": [
      "string"
    ],
    "resourcePools": [
      "string"
    ]
  },
  "datacenter": "string"
}

→

https://api.spectrocloud.com/v1/cloudaccounts/vsphere/{uid}/properties/datacenters

summary:

Get the vSphere datacenters & datacluster for the given overlord account

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 200
Description: (empty)
Response body:

{
  "items": [
    {
      "computeclusters": [
        "string"
      ],
      "datacenter": "string",
      "folders": [
        "string"
      ]
    }
  ]
}

→

https://api.spectrocloud.com/v1/cloudaccounts/{uid}/geoLocation

summary:

Update the geolocation annotation

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "latitude": "number",
  "longitude": "number"
}

HTTP code: 204
Description: The resource was updated successfully

Edit on GitHub