Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Scale Computing Platform REST API Examples
# Scale Computing Platform REST API Examples

This repository contains several example scripts for running API queries against a HyperCore cluster or Fleet Manager.
This repository contains several example scripts for running API queries against an **SC//HyperCore™** cluster or **SC//Fleet™** platform manager.

These scripts are only examples and demonstrate common use cases with the APIs.
These scripts are only examples and demonstrate common use cases with the APIs.

Refer to this repository's tags for examples tied to a specific Scale release.
Refer to this repository's tags for examples tied to a specific Scale Computing release.

## Full swagger documentation for the APIs

Expand All @@ -15,7 +15,13 @@ HyperCore API: http://[Your_Clustered_Node_IP}/rest/v1/docs/
A link to the HyperCore API documentation is also available in the Support tab of the Control Panel
![image](https://github.com/user-attachments/assets/107d6c07-5a70-4749-b6f6-8c4780982ba4)

Other automation tools that utilize these apis include:
Other automation tools that utilize these APIs include:

Scale Computing Ansible Collection for HyperCore - see https://github.com/ScaleComputing/HyperCoreAnsibleCollection
Scale Computing Terraform Provider for HyperCore - see https://github.com/ScaleComputing/terraform-provider-hypercore
Scale Computing™ Ansible® Collection for HyperCore — https://github.com/ScaleComputing/HyperCoreAnsibleCollection
Scale Computing™ Terraform® Provider for HyperCore — https://github.com/ScaleComputing/terraform-provider-hypercore

---

SC//HyperCore™ and SC//Fleet™ are trademarks of Scale Computing, Inc.

Ansible® is a registered trademark of Red Hat, Inc. Terraform® is a registered trademark of HashiCorp, Inc. All other trademarks are the property of their respective owners.
2 changes: 1 addition & 1 deletion platform_2025/Platform2025_SnapshotExampleBash.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/bin/bash

SCUSERNAME="YOUR_USERNAME" # User on a Scale Compuintg cluster with the backup right assigned
SCUSERNAME="YOUR_USERNAME" # User on a Scale Computing HyperCore cluster with the backup right assigned
SCPASSWD="YOUR_PASSWORD" # Password for that user
SCNODE="IP_OR_FQDN_OF_ONE_NODE" # IP or FQDN for the cluster
VMUUID="01234567-89ab-cdef-0123-456789abcdef" # UUID of the VM we want to make a snapshot of
Expand Down
2 changes: 1 addition & 1 deletion platform_2025/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Scale Computing Platform REST API Examples
# Scale Computing Platform REST API Examples

This folder contains the example scripts used during the SC//Platform 'Maximizing Hypercore Rest API' session.

Expand Down
6 changes: 3 additions & 3 deletions specific_task/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Scale Computing System REST API Examples - Task Specific

This repository contains scripts for running task-specific API queries against a Scale system.
This repository contains scripts for running task-specific API queries against a SC//HyperCore™ cluster.

These scripts are only examples and demonstrate common use cases with the API.
Refer to the API docs on a scale system for a detailed guide on available calls.
These scripts are only examples and demonstrate common use cases with the API.
Refer to the API docs on a SC//HyperCore™ cluster for a detailed guide on available calls.


### SnapshotReport.ps1
Expand Down
2 changes: 1 addition & 1 deletion specific_task/SetTag.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ param(
[string]$vmString,
[Parameter(mandatory=$true)]
[string]$setTag,
[PSCredential] $Cred = (Get-Credential -Message "Enter Scale HC3 Credentials")
[PSCredential] $Cred = (Get-Credential -Message "Enter SC//HyperCore Credentials")
)


Expand Down
2 changes: 1 addition & 1 deletion specific_task/iso-upload.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Param(
[Parameter(Mandatory = $true,Position = 0)]
[ValidateNotNullOrEmpty()]
[string] $Server,
[PSCredential] $Credential = (Get-Credential -Message "Enter Scale HC3 Credentials"),
[PSCredential] $Credential = (Get-Credential -Message "Enter SC//HyperCore Credentials"),
[switch] $SkipCertificateCheck
)

Expand Down
2 changes: 1 addition & 1 deletion vm-lifecycle.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Param(
[Parameter(Mandatory = $true,Position = 0)]
[ValidateNotNullOrEmpty()]
[string] $Server,
[PSCredential] $Credential = (Get-Credential -Message "Enter Scale HC3 Credentials"),
[PSCredential] $Credential = (Get-Credential -Message "Enter SC//HyperCore Credentials"),
[switch] $SkipCertificateCheck
)

Expand Down