Datacenters/clusters

• Datacenters and clusters
  • getGet applications
  • getGet datacenters/clusters
  • getGet datacenter/cluster
  • getGet histories
  • getGet members
  • getGet member
  • getGet features
• Datacenters and clusters hypervisors
  • getGet hypervisor types
  • getGet hypervisor type

API docs by Redocly

SAM: Datacenters/clusters (1.0.0)

Download OpenAPI specification:Download

URL: https://www.snowsoftware.com

API for exploring datacenters/clusters.

Datacenters and clusters

Get applications

Returns a collection of members and links to computer applications for a given datacenter/cluster.

Authorizations:

BearerAuth

path Parameters

id required

string The unique ID of the datacenter/cluster.

query Parameters

page_size	integer <= 1000 Default: 100 The maximum number of items in the response.
page_number	integer <int64> Default: 1 The page number.
filter	string Example: filter=status -eq "active" For more information on the available operators and which data types those operators work on, see Filter API call results.

Responses

https://{region}.snowsoftware.io/api/sam/estate/v1/dcc/{id}/applications

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "api/sam/estate/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "items": [

  • {

    • "_links": [

      • {

        • "href": "api/sam/estate/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "cc39d7c1-0d45-43c6-9fea-d5c091f94556",
    • "computerId": "15764003-3c61-4d5f-9839-a63271240519",
    • "sourceId": 456

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 1

  }

}

Get datacenters/clusters

Returns a collection of datacenters/clusters.

Authorizations:

BearerAuth

query Parameters

page_size	integer <= 1000 Default: 100 The maximum number of items in the response.
page_number	integer <int64> Default: 1 The page number.
filter	string Example: filter=status -eq "active" For more information on the available operators and which data types those operators work on, see Filter API call results.

Responses

https://{region}.snowsoftware.io/api/sam/estate/v1/dcc

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "api/sam/estate/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "items": [

  • {

    • "_links": [

      • {

        • "href": "api/sam/estate/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "cc39d7c1-0d45-43c6-9fea-d5c091f94556",
    • "controllerId": 1234,
    • "name": "DCC 1",
    • "description": "The first datacenter/cluster",
    • "organizationId": "f34c5dc6-5fa7-491c-bee6-b0a57c215501",
    • "virtualPeakIntervalDays": 5,
    • "virtualPeakIntervalType": 3,
    • "virtualPeakCount": 7,
    • "virtualPeakDate": "2019-08-24T14:15:22Z",
    • "isAutoGenerated": true,
    • "hypervisor": "f6994068-c37c-4846-8a9d-8a35a9cc565c",
    • "isHighAvailability": true,
    • "isVMwareDRS": true,
    • "isHypervisorFromSIM": true

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 1

  }

}

Get datacenter/cluster

Returns the details of a given datacenter/cluster.

Authorizations:

BearerAuth

path Parameters

id required

string The unique ID of the datacenter/cluster.

Responses

https://{region}.snowsoftware.io/api/sam/estate/v1/dcc/{id}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "api/sam/estate/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "items": [

  • {

    • "_links": [

      • {

        • "href": "api/sam/estate/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "cc39d7c1-0d45-43c6-9fea-d5c091f94556",
    • "name": "Hypervisor 1"

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 1

  }

}

Get histories

Returns a collection of histories for a given datacenter/cluster.

Authorizations:

BearerAuth

path Parameters

id required

string The unique ID of the datacenter/cluster.

query Parameters

page_size	integer <= 1000 Default: 100 The maximum number of items in the response.
page_number	integer <int64> Default: 1 The page number.
filter	string Example: filter=status -eq "active" For more information on the available operators and which data types those operators work on, see Filter API call results.

Responses

https://{region}.snowsoftware.io/api/sam/estate/v1/dcc/{id}/history

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "api/sam/estate/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "items": [

  • {

    • "_links": [

      • {

        • "href": "api/sam/estate/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "cc39d7c1-0d45-43c6-9fea-d5c091f94556",
    • "virtualMachineDate": "2019-08-24T14:15:22Z",
    • "virtualMachineCount": 3

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 1

  }

}

Get members

Returns a collection of members for a given datacenter/cluster.

Authorizations:

BearerAuth

path Parameters

id required

string The unique ID of the datacenter/cluster.

query Parameters

page_size	integer <= 1000 Default: 100 The maximum number of items in the response.
page_number	integer <int64> Default: 1 The page number.
filter	string Example: filter=status -eq "active" For more information on the available operators and which data types those operators work on, see Filter API call results.

Responses

https://{region}.snowsoftware.io/api/sam/estate/v1/dcc/{id}/members

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "api/sam/estate/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "items": [

  • {

    • "_links": [

      • {

        • "href": "api/sam/estate/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "cc39d7c1-0d45-43c6-9fea-d5c091f94556",
    • "computerId": "15764003-3c61-4d5f-9839-a63271240519",
    • "sourceId": 456

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 1

  }

}

Get member

Returns the details of a given member for a given unique datacenter/cluster.

Authorizations:

BearerAuth

path Parameters

id required	string The unique ID of the datacenter/cluster.
memberId required	string The unique ID of the member of the datacenter/cluster.

Responses

https://{region}.snowsoftware.io/api/sam/estate/v1/dcc/{id}/members/{memberId}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "api/sam/estate/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "id": "cc39d7c1-0d45-43c6-9fea-d5c091f94556",
• "computerId": "15764003-3c61-4d5f-9839-a63271240519",
• "sourceId": 456

}

Get features

Returns a collection of features for a given member of a given datacenter/cluster.

Authorizations:

BearerAuth

path Parameters

id required	string The unique ID of the datacenter/cluster.
memberId required	string The unique ID of the member of the datacenter/cluster.

query Parameters

page_size	integer <= 1000 Default: 100 The maximum number of items in the response.
page_number	integer <int64> Default: 1 The page number.
filter	string Example: filter=status -eq "active" For more information on the available operators and which data types those operators work on, see Filter API call results.

Responses

https://{region}.snowsoftware.io/api/sam/estate/v1/dcc/{id}/members/{memberId}/features

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "api/sam/estate/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "items": [

  • {

    • "_links": [

      • {

        • "href": "api/sam/estate/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "cc39d7c1-0d45-43c6-9fea-d5c091f94556",
    • "computerId": "15764003-3c61-4d5f-9839-a63271240519",
    • "featureName": "Feature 1",
    • "isRequiresLicense": true,
    • "isActive": true,
    • "sourceId": 456

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 1

  }

}

Datacenters and clusters hypervisors

Get hypervisor types

Returns a collection of hypervisor types.

Authorizations:

BearerAuth

query Parameters

page_size	integer <= 1000 Default: 100 The maximum number of items in the response.
page_number	integer <int64> Default: 1 The page number.
filter	string Example: filter=status -eq "active" For more information on the available operators and which data types those operators work on, see Filter API call results.

Responses

https://{region}.snowsoftware.io/api/sam/estate/v1/dcc-hypervisors

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "api/sam/estate/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "items": [

  • {

    • "_links": [

      • {

        • "href": "api/sam/estate/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "cc39d7c1-0d45-43c6-9fea-d5c091f94556",
    • "name": "Hypervisor 1"

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 1

  }

}

Get hypervisor type

Returns the details of a hypervisor type for a given datacenter/cluster hypervisor.

Authorizations:

BearerAuth

path Parameters

id required

string The unique ID of the datacenter/cluster hypervisor.

Responses

https://{region}.snowsoftware.io/api/sam/estate/v1/dcc-hypervisors/{id}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "api/sam/estate/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "id": "cc39d7c1-0d45-43c6-9fea-d5c091f94556",
• "name": "Hypervisor 1"

}