Connecting to the API

The MetalSoft uses an OpenAPI REST-based API.

For a quick getting started with it use the Postman collections:

• Redoc documentation https://<environment_hostname>/api/v2/redoc
• Swagger documentation https://<environment_hostname>/api/v2/swagger

The API endpoint:

The API endpoint is found at:

https://<environment_hostname>/api/v2

Retrieving my API key and connecting to the endpoint

Login then click on API credentials on the upper right corner.

Then click on the API key input to display your API key.

The API key can be regenerated if it is compromised by clicking the “Generate a new key” button.

Authenticating to the API

The authentication uses the API Key in the Bearer header of all HTTP request methods.

• Authorization: Bearer <API_Key> header. Note that the API key can be regenerated at any time using the UI and should be rotated periodically.

Common examples

List all servers

curl "https://<your-server>/api/v2/servers" \
  -H "Authorization: Bearer <API_KEY>"

List all infrastructures

curl "https://<your-server>/api/v2/infrastructures" \
  -H "Authorization: Bearer <API_KEY>"

Get details for a specific server

curl "https://<your-server>/api/v2/servers/{serverId}" \
  -H "Authorization: Bearer <API_KEY>"

Create an infrastructure

curl -X POST "https://<your-server>/api/v2/infrastructures" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <API_KEY>" \
  -d '{
    "siteId": 1,
    "label": "my-infrastructure"
  }'

Deploy an infrastructure

curl -X POST "https://<your-server>/api/v2/infrastructures/{infrastructureId}/actions/deploy" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <API_KEY>" \
  -d '{
    "allowDataLoss": false,
    "shutdownOptions": {
      "attemptSoftShutdown": true,
      "softShutdownTimeoutSeconds": 180
    }
  }'

List all network fabrics

curl "https://<your-server>/api/v2/network-fabrics" \
  -H "Authorization: Bearer <API_KEY>"

Get current user details

curl "https://<your-server>/api/v2/user" \
  -H "Authorization: Bearer <API_KEY>"

Pagination

List endpoints support pagination via page and limit query parameters:

curl "https://<your-server>/api/v2/servers?page=1&limit=50" \
  -H "Authorization: Bearer <API_KEY>"

Additional resources

Consult the MetalSoft PostMan REST Workspace for in-depth details on how to use the API.