Powered by Algolia

    Cloud Accounts

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

    summary:
    Retrieves a list of AWS cloud accounts
    Parameters:
    NameTypeDescriptionRequired
    fieldsstringSet of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.nameno
    filtersstringFilters 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
    orderBystringSpecify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1no
    limitintegerlimit is a maximum number of responses to return for a list call. 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
    continuestringcontinue token for the datasetno
    200
    An array of cloud account items
    {
    "items": [
    {
    "apiVersion": "string",
    "kind": "string",
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "accessKey": "string",
    "secretKey": "string"
    },
    "status": {
    "state": "string"
    }
    }
    ],
    "listmeta": {
    "continue": "string",
    "count": "integer"
    }
    }

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

    summary:
    Creates an AWS cloud account
    {
    "apiVersion": "string",
    "kind": "string",
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "accessKey": "string",
    "secretKey": "string"
    },
    "status": {
    "state": "string"
    }
    }
    201
    Created successfully
    {
    "uid": "string"
    }

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

    summary:
    Returns the specified AWS account
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    200
    OK
    {
    "apiVersion": "string",
    "kind": "string",
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "accessKey": "string",
    "secretKey": "string"
    },
    "status": {
    "state": "string"
    }
    }

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

    summary:
    Updates the specified AWS account
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    {
    "apiVersion": "string",
    "kind": "string",
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "accessKey": "string",
    "secretKey": "string"
    },
    "status": {
    "state": "string"
    }
    }
    204
    The resource was updated successfully

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

    summary:
    Deletes the specified AWS account
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    204
    The resource was deleted successfully

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

    summary:
    Patches the specified CloudAccount Aws
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    {
    "items": {
    "from": "string",
    "op": "string",
    "path": "string",
    "value": "object"
    }
    }
    204
    The resource was updated successfully

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

    summary:
    Retrieves a list of azure cloud accounts
    Parameters:
    NameTypeDescriptionRequired
    fieldsstringSet of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.nameno
    filtersstringFilters 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
    orderBystringSpecify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1no
    limitintegerlimit is a maximum number of responses to return for a list call. 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
    continuestringcontinue token for the datasetno
    200
    An array of azure cloud account items
    {
    "items": [
    {
    "apiVersion": "string",
    "kind": "string",
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "clientId": "string",
    "clientSecret": "string",
    "tenantId": "string"
    },
    "status": {
    "state": "string"
    }
    }
    ],
    "listmeta": {
    "continue": "string",
    "count": "integer"
    }
    }

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

    summary:
    Create azure cloud account
    {
    "apiVersion": "string",
    "kind": "string",
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "clientId": "string",
    "clientSecret": "string",
    "tenantId": "string"
    },
    "status": {
    "state": "string"
    }
    }
    201
    Created successfully
    {
    "uid": "string"
    }

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

    summary:
    Returns the specified azure cloud account
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    200
    OK
    {
    "apiVersion": "string",
    "kind": "string",
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "clientId": "string",
    "clientSecret": "string",
    "tenantId": "string"
    },
    "status": {
    "state": "string"
    }
    }

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

    summary:
    Updates the specified azure account
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    {
    "apiVersion": "string",
    "kind": "string",
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "clientId": "string",
    "clientSecret": "string",
    "tenantId": "string"
    },
    "status": {
    "state": "string"
    }
    }
    204
    The resource was updated successfully

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

    summary:
    Deletes the specified azure account
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    204
    The resource was deleted successfully

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

    summary:
    Patches the specified CloudAccount azure
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    {
    "items": {
    "from": "string",
    "op": "string",
    "path": "string",
    "value": "object"
    }
    }
    204
    The resource was updated successfully

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

    summary:
    Retrieves a list of gcp cloud accounts
    Parameters:
    NameTypeDescriptionRequired
    fieldsstringSet of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.nameno
    filtersstringFilters 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
    orderBystringSpecify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1no
    limitintegerlimit is a maximum number of responses to return for a list call. 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
    continuestringcontinue token for the datasetno
    200
    An array of gcp cloud account items
    {
    "items": [
    {
    "apiVersion": "string",
    "kind": "string",
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "jsonCredentials": "string",
    "jsonCredentialsFileName": "string"
    },
    "status": {
    "state": "string"
    }
    }
    ],
    "listmeta": {
    "continue": "string",
    "count": "integer"
    }
    }

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

    summary:
    Creates a GCP cloud account
    {
    "apiVersion": "string",
    "kind": "string",
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "jsonCredentials": "string",
    "jsonCredentialsFileUid": "string"
    },
    "status": {
    "state": "string"
    }
    }
    201
    Created successfully
    {
    "uid": "string"
    }

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

    summary:
    Returns the specified GCP cloud account
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    200
    OK
    {
    "apiVersion": "string",
    "kind": "string",
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "jsonCredentials": "string",
    "jsonCredentialsFileName": "string"
    },
    "status": {
    "state": "string"
    }
    }

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

    summary:
    Updates the specified GCP account
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    {
    "apiVersion": "string",
    "kind": "string",
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "jsonCredentials": "string",
    "jsonCredentialsFileUid": "string"
    },
    "status": {
    "state": "string"
    }
    }
    204
    The resource was updated successfully

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

    summary:
    Deletes the specified GCP account
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    204
    The resource was deleted successfully

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

    summary:
    Patches the specified CloudAccount gcp
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    {
    "items": {
    "from": "string",
    "op": "string",
    "path": "string",
    "value": "object"
    }
    }
    204
    The resource was updated successfully

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

    summary:
    Retrieves a list of cloud accounts summary
    Parameters:
    NameTypeDescriptionRequired
    filtersstringFilters 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
    orderBystringSpecify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1no
    limitintegerlimit is a maximum number of responses to return for a list call. 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
    continuestringcontinue token for the datasetno
    200
    An array of cloud account summary items
    {
    "items": [
    {
    "kind": "string",
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "specSummary": {
    "accountId": "string"
    },
    "status": {
    "state": "string"
    }
    }
    ],
    "listmeta": {
    "continue": "string",
    "count": "integer"
    }
    }

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

    summary:
    Retrieves a list of vSphere cloud accounts
    Parameters:
    NameTypeDescriptionRequired
    fieldsstringSet of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.nameno
    filtersstringFilters 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
    orderBystringSpecify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1no
    limitintegerlimit is a maximum number of responses to return for a list call. 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
    continuestringcontinue token for the datasetno
    200
    An array of cloud account items
    {
    "items": [
    {
    "apiVersion": "string",
    "kind": "string",
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "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"
    }
    }

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

    summary:
    Creates a vSphere cloud account
    {
    "apiVersion": "string",
    "kind": "string",
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "insecure": "boolean",
    "password": "string",
    "username": "string",
    "vcenterServer": "string"
    },
    "status": {
    "state": "string"
    }
    }
    201
    Created successfully
    {
    "uid": "string"
    }

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

    summary:
    Returns the specified vSphere account
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    200
    OK
    {
    "apiVersion": "string",
    "kind": "string",
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "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/v1alpha1/cloudaccounts/vsphere/{uid}

    summary:
    Updates the specified VSphere account
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    {
    "apiVersion": "string",
    "kind": "string",
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "insecure": "boolean",
    "password": "string",
    "username": "string",
    "vcenterServer": "string"
    },
    "status": {
    "state": "string"
    }
    }
    204
    The resource was updated successfully

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

    summary:
    Deletes the specified vSphere account
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    204
    The resource was deleted successfully

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

    summary:
    Patches the specified CloudAccount Vsphere
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    {
    "items": {
    "from": "string",
    "op": "string",
    "path": "string",
    "value": "object"
    }
    }
    204
    The resource was updated successfully

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

    summary:
    Get the vSphere computecluster resources for the given overlord account
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    datacenterstringyes
    computeclusterstringyes
    200
    (empty)
    {
    "computecluster": {
    "datastores": [
    "string"
    ],
    "name": "string",
    "networks": [
    "string"
    ],
    "resourcePools": [
    "string"
    ]
    },
    "datacenter": "string"
    }

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

    summary:
    Get the vSphere datacenters & datacluster for the given overlord account
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    200
    (empty)
    {
    "items": [
    {
    "computeclusters": [
    "string"
    ],
    "datacenter": "string",
    "folders": [
    "string"
    ]
    }
    ]
    }