Sign in

v1

latestOpenAPI 3.0.02026-07-1774355.5 KB

Get information about infrastructures

get/v0.7.0/infrastructures

Query parameters

namestring

Filter infrastructures by name

tagsstring[]

Filter infrastructures by tag

{"stackTrail":"paths:/v0.7.0/infrastructures:get:parameters:2:schema","oasType":"schema","type":"unknown"}

Get list of object names instead of full objects

{"stackTrail":"paths:/v0.7.0/infrastructures:get:parameters:3:schema","oasType":"schema","type":"unknown"}

Fold expandable objects

{"stackTrail":"paths:/v0.7.0/infrastructures:get:parameters:4:schema","oasType":"schema","type":"unknown"}

Report object types in YAML dumps

format'yaml' | 'json'

Select output format

Response

successful operation

descriptionstring

Text description of the infrastructure.

namestring

The name of the infrastructure.

tagsstring[]

List of tags associated to the infrastructure.

Example response

[
  {
    "description": "HPC cluster",
    "layout": [
      {
        "misc": [],
        "network": [],
        "nodes": [],
        "rack": "A[01-10]",
        "storage": [],
        "tags": [
          "compute"
        ]
      }
    ],
    "name": "mercury",
    "tags": [
      "hpc"
    ]
  }
]