Infrastructure

Endpoints related to managing physical/virtual infrastructure on Cycle.

Get Infrastructure Summary

Requires the infrastructure-servers-view capability.

SecuritybearerAuth and hubAuth

Request

query Parameters

object

Filter Field

The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.

Responses

200

Returns an infrastructure summary.

default

General error response from the platform

get/v1/infrastructure/summary

Response samples

200
default

application/json

{"data": {"hub_id": "651586fca6078e98982dbd90",
"servers": 0,
"images": {"tier": {"total_mb": 0,
"allocated_mb": 0,
"used_mb": 0
}
},
"clusters": {"property1": {"name": "string",
"resources": {"ram": {"total_mb": 0,
"allocated_mb": 0,
"used_mb": 0,
"provisioned_mb": 0
},
"cpu": {"cores": 0,
"shares": {"allocated": 0,
"total": 0
},
"share_ratio": 0
}
},
"healthy": true,
"versions": {"agent": {"property1": 0,
"property2": 0
},
"agent-spawner": {"property1": 0,
"property2": 0
},
"compute": {"property1": 0,
"property2": 0
},
"compute-spawner": {"property1": 0,
"property2": 0
}
},
"instances": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"servers": {"count": 0,
"providers": {"property1": {"count": 0,
"locations": {"property1": null,
"property2": null
},
"models": {"property1": null,
"property2": null
},
"resources": {"ram": { },
"cpu": { }
}
},
"property2": {"count": 0,
"locations": {"property1": null,
"property2": null
},
"models": {"property1": null,
"property2": null
},
"resources": {"ram": { },
"cpu": { }
}
}
},
"server_ids": ["651586fca6078e98982dbd90"
]
}
},
"property2": {"name": "string",
"resources": {"ram": {"total_mb": 0,
"allocated_mb": 0,
"used_mb": 0,
"provisioned_mb": 0
},
"cpu": {"cores": 0,
"shares": {"allocated": 0,
"total": 0
},
"share_ratio": 0
}
},
"healthy": true,
"versions": {"agent": {"property1": 0,
"property2": 0
},
"agent-spawner": {"property1": 0,
"property2": 0
},
"compute": {"property1": 0,
"property2": 0
},
"compute-spawner": {"property1": 0,
"property2": 0
}
},
"instances": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"servers": {"count": 0,
"providers": {"property1": {"count": 0,
"locations": {"property1": null,
"property2": null
},
"models": {"property1": null,
"property2": null
},
"resources": {"ram": { },
"cpu": { }
}
},
"property2": {"count": 0,
"locations": {"property1": null,
"property2": null
},
"models": {"property1": null,
"property2": null
},
"resources": {"ram": { },
"cpu": { }
}
}
},
"server_ids": ["651586fca6078e98982dbd90"
]
}
}
},
"updated": "2021-01-30T08:30:00Z"
}
}

Get Deployment Strategies

Gets the available deployment strategies that can be used to orchestrate containers.

SecuritybearerAuth and hubAuth

Responses

200

Returns available deployment strategies.

default

General error response from the platform

get/v1/infrastructure/deployment-strategies

Response samples

200
default

application/json

{"data": {"resource-density": {"name": "string",
"disabled": true,
"description": "string"
},
"high-availability": {"name": "string",
"disabled": true,
"description": "string"
},
"first-available": {"name": "string",
"disabled": true,
"description": "string"
},
"node": {"name": "string",
"disabled": true,
"description": "string"
},
"edge": {"name": "string",
"disabled": true,
"description": "string"
},
"manual": {"name": "string",
"disabled": true,
"description": "string"
},
"function": {"name": "string",
"disabled": true,
"description": "string"
}
}
}

➔ Next to Auto-Scale Groups