Fractal Live Systems (v1)

Download OpenAPI specification:Download

Fractal Cloud: contact-us@fractal.cloud URL: https://fractal.cloud/

Fractal Live Systems description

Health

/Health

Authorizations:

Bearer

Responses

LiveSystems

/LiveSystems

Authorizations:

Bearer

Request Body schema:
application/json

liveSystemId	string or null
fractalId	string or null
description	string or null
provider	string or null
	object or null
	object (EnvironmentDto)

Responses

Request samples

Payload

Content type

application/json

{"liveSystemId": "string",
"fractalId": "string",
"description": "string",
"provider": "string",
"blueprintMap": {"property1": {"displayName": "string",
"description": "string",
"type": "string",
"id": "string",
"version": "string",
"locked": true,
"recreateOnFailure": true,
"parameters": {"property1": null,
"property2": null
},
"dependencies": ["string"
],
"links": [{"componentId": "string",
"settings": {"property1": null,
"property2": null
}
}
],
"status": "Unknown",
"outputFields": {"property1": null,
"property2": null
},
"lastUpdated": "2019-08-24T14:15:22Z",
"lastOperationRetried": 0,
"provider": "Unknown",
"lastOperationStatusMessage": "string",
"checksum": "string",
"systemMutationId": "dc2c0188-05a1-4004-9020-54751fd24915",
"errorCode": "string"
},
"property2": {"displayName": "string",
"description": "string",
"type": "string",
"id": "string",
"version": "string",
"locked": true,
"recreateOnFailure": true,
"parameters": {"property1": null,
"property2": null
},
"dependencies": ["string"
],
"links": [{"componentId": "string",
"settings": {"property1": null,
"property2": null
}
}
],
"status": "Unknown",
"outputFields": {"property1": null,
"property2": null
},
"lastUpdated": "2019-08-24T14:15:22Z",
"lastOperationRetried": 0,
"provider": "Unknown",
"lastOperationStatusMessage": "string",
"checksum": "string",
"systemMutationId": "dc2c0188-05a1-4004-9020-54751fd24915",
"errorCode": "string"
}
},
"environment": {"id": {"type": "Unknown",
"ownerId": "4d206909-730f-409a-88f6-dcfaa8fc28cc",
"shortName": "string"
},
"parameters": {"property1": null,
"property2": null
}
}
}

Response samples

200

Content type

text/plain

No sample

/LiveSystems

Authorizations:

Bearer

Responses

Response samples

200

Content type

text/plain

No sample

/LiveSystems/{resourceGroupType}/{resourceGroupOwnerId}/{resourceGroupShortName}/{liveSystemName}

Authorizations:

Bearer

path Parameters

resourceGroupType required	stringPersonal\|Organizational
resourceGroupOwnerId required	string <uuid>
resourceGroupShortName required	string
liveSystemName required	string

Request Body schema:
application/json

liveSystemId	string or null
fractalId	string or null
description	string or null
provider	string or null
	object or null
	object (EnvironmentDto)
newResourceGroupId	string or null
newLiveSystemName	string or null

Responses

Request samples

Payload

Content type

application/json

{"liveSystemId": "string",
"fractalId": "string",
"description": "string",
"provider": "string",
"blueprintMap": {"property1": {"displayName": "string",
"description": "string",
"type": "string",
"id": "string",
"version": "string",
"locked": true,
"recreateOnFailure": true,
"parameters": {"property1": null,
"property2": null
},
"dependencies": ["string"
],
"links": [{"componentId": "string",
"settings": {"property1": null,
"property2": null
}
}
],
"status": "Unknown",
"outputFields": {"property1": null,
"property2": null
},
"lastUpdated": "2019-08-24T14:15:22Z",
"lastOperationRetried": 0,
"provider": "Unknown",
"lastOperationStatusMessage": "string",
"checksum": "string",
"systemMutationId": "dc2c0188-05a1-4004-9020-54751fd24915",
"errorCode": "string"
},
"property2": {"displayName": "string",
"description": "string",
"type": "string",
"id": "string",
"version": "string",
"locked": true,
"recreateOnFailure": true,
"parameters": {"property1": null,
"property2": null
},
"dependencies": ["string"
],
"links": [{"componentId": "string",
"settings": {"property1": null,
"property2": null
}
}
],
"status": "Unknown",
"outputFields": {"property1": null,
"property2": null
},
"lastUpdated": "2019-08-24T14:15:22Z",
"lastOperationRetried": 0,
"provider": "Unknown",
"lastOperationStatusMessage": "string",
"checksum": "string",
"systemMutationId": "dc2c0188-05a1-4004-9020-54751fd24915",
"errorCode": "string"
}
},
"environment": {"id": {"type": "Unknown",
"ownerId": "4d206909-730f-409a-88f6-dcfaa8fc28cc",
"shortName": "string"
},
"parameters": {"property1": null,
"property2": null
}
},
"newResourceGroupId": "string",
"newLiveSystemName": "string"
}

Response samples

200

Content type

text/plain

No sample

/LiveSystems/{resourceGroupType}/{resourceGroupOwnerId}/{resourceGroupShortName}/{liveSystemName}

Authorizations:

Bearer

path Parameters

resourceGroupType required	stringPersonal\|Organizational
resourceGroupOwnerId required	string <uuid>
resourceGroupShortName required	string
liveSystemName required	string

Responses

/LiveSystems/{resourceGroupType}/{resourceGroupOwnerId}/{resourceGroupShortName}/{liveSystemName}

Authorizations:

Bearer

path Parameters

resourceGroupType required	stringPersonal\|Organizational
resourceGroupOwnerId required	string <uuid>
resourceGroupShortName required	string
liveSystemName required	string

Responses

Response samples

200

Content type

text/plain

No sample

/LiveSystems/{resourceGroupId}/{liveSystemName} Deprecated

Authorizations:

Bearer

path Parameters

resourceGroupId required	string
liveSystemName required	string

Request Body schema:
application/json

liveSystemId	string or null
fractalId	string or null
description	string or null
provider	string or null
	object or null
	object (EnvironmentDto)
newResourceGroupId	string or null
newLiveSystemName	string or null

Responses

Request samples

Payload

Content type

application/json

{"liveSystemId": "string",
"fractalId": "string",
"description": "string",
"provider": "string",
"blueprintMap": {"property1": {"displayName": "string",
"description": "string",
"type": "string",
"id": "string",
"version": "string",
"locked": true,
"recreateOnFailure": true,
"parameters": {"property1": null,
"property2": null
},
"dependencies": ["string"
],
"links": [{"componentId": "string",
"settings": {"property1": null,
"property2": null
}
}
],
"status": "Unknown",
"outputFields": {"property1": null,
"property2": null
},
"lastUpdated": "2019-08-24T14:15:22Z",
"lastOperationRetried": 0,
"provider": "Unknown",
"lastOperationStatusMessage": "string",
"checksum": "string",
"systemMutationId": "dc2c0188-05a1-4004-9020-54751fd24915",
"errorCode": "string"
},
"property2": {"displayName": "string",
"description": "string",
"type": "string",
"id": "string",
"version": "string",
"locked": true,
"recreateOnFailure": true,
"parameters": {"property1": null,
"property2": null
},
"dependencies": ["string"
],
"links": [{"componentId": "string",
"settings": {"property1": null,
"property2": null
}
}
],
"status": "Unknown",
"outputFields": {"property1": null,
"property2": null
},
"lastUpdated": "2019-08-24T14:15:22Z",
"lastOperationRetried": 0,
"provider": "Unknown",
"lastOperationStatusMessage": "string",
"checksum": "string",
"systemMutationId": "dc2c0188-05a1-4004-9020-54751fd24915",
"errorCode": "string"
}
},
"environment": {"id": {"type": "Unknown",
"ownerId": "4d206909-730f-409a-88f6-dcfaa8fc28cc",
"shortName": "string"
},
"parameters": {"property1": null,
"property2": null
}
},
"newResourceGroupId": "string",
"newLiveSystemName": "string"
}

Response samples

200

Content type

text/plain

No sample

/LiveSystems/{resourceGroupId}/{liveSystemName} Deprecated

Authorizations:

Bearer

path Parameters

resourceGroupId required	string
liveSystemName required	string

Responses

/LiveSystems/{resourceGroupId}/{liveSystemName} Deprecated

Authorizations:

Bearer

path Parameters

resourceGroupId required	string
liveSystemName required	string

Responses

Response samples

200

Content type

text/plain

No sample

/LiveSystems/{resourceGroupType}/{resourceGroupOwnerId}/{resourceGroupShortName}/{liveSystemName}/mutations/{mutationId}

Authorizations:

Bearer

path Parameters

resourceGroupType required	stringPersonal\|Organizational
resourceGroupOwnerId required	string <uuid>
resourceGroupShortName required	string
liveSystemName required	string
mutationId required	string <uuid>

Responses

Response samples

200

Content type

text/plain

No sample

/LiveSystems/{resourceGroupId}/{liveSystemName}/mutations/{mutationId} Deprecated

Authorizations:

Bearer

path Parameters

resourceGroupId required	string
liveSystemName required	string
mutationId required	string <uuid>

Responses

Response samples

200

Content type

text/plain

No sample

/LiveSystems/{resourceGroupType}/{resourceGroupOwnerId}/{resourceGroupShortName}/{liveSystemName}/component/{componentId}/instantiate

Authorizations:

Bearer

path Parameters

resourceGroupType required	stringPersonal\|Organizational
resourceGroupOwnerId required	string <uuid>
resourceGroupShortName required	string
liveSystemName required	string
componentId required	string

Responses

Response samples

200

Content type

text/plain

No sample

/LiveSystems/{resourceGroupId}/{liveSystemName}/component/{componentId}/instantiate Deprecated

Authorizations:

Bearer

path Parameters

resourceGroupId required	string
liveSystemName required	string
componentId required	string

Responses

Response samples

200

Content type

text/plain

No sample

/LiveSystems/{resourceGroupType}/{resourceGroupOwnerId}/{resourceGroupShortName}/{liveSystemName}/component/{componentId}/state/{mutationId}

Authorizations:

Bearer

path Parameters

resourceGroupType required	stringPersonal\|Organizational
resourceGroupOwnerId required	string <uuid>
resourceGroupShortName required	string
liveSystemName required	string
componentId required	string
mutationId required	string <uuid>

Responses

Response samples

200

Content type

text/plain

No sample

/LiveSystems/{resourceGroupId}/{liveSystemName}/component/{componentId}/state/{mutationId} Deprecated

Authorizations:

Bearer

path Parameters

resourceGroupId required	string
liveSystemName required	string
componentId required	string
mutationId required	string <uuid>

Responses

Response samples

200

Content type

text/plain

No sample

/LiveSystems/{resourceGroupType}/{resourceGroupOwnerId}/{resourceGroupShortName}/{liveSystemName}/components/{componentId}

Authorizations:

Bearer

path Parameters

resourceGroupType required	stringPersonal\|Organizational
resourceGroupOwnerId required	string <uuid>
resourceGroupShortName required	string
liveSystemName required	string
componentId required	string

Request Body schema:
application/json

object (LiveSystemComponentDto)

displayName	string or null
description	string or null
type	string or null
id	string or null
version	string or null
locked	boolean
recreateOnFailure	boolean
	object or null
dependencies	Array of strings or null unique
	Array of objects or null (ComponentLinkDto)
status	string (LiveSystemComponentStatus) Enum: "Unknown" "Instantiating" "Active" "Failed" "Mutating" "Deleting" "Deleted" "Cancelled"
	object or null
lastUpdated	string <date-time>
lastOperationRetried	integer <int32>
provider	string (ProviderType) Enum: "Unknown" "AWS" "GCP" "Azure" "CaaS" "SaaS" "OCI" "Hetzner"
lastOperationStatusMessage	string or null
checksum	string or null <byte>
systemMutationId	string <uuid>
errorCode	string or null

Responses

Request samples

Payload

Content type

application/json

{"component": {"displayName": "string",
"description": "string",
"type": "string",
"id": "string",
"version": "string",
"locked": true,
"recreateOnFailure": true,
"parameters": {"property1": null,
"property2": null
},
"dependencies": ["string"
],
"links": [{"componentId": "string",
"settings": {"property1": null,
"property2": null
}
}
],
"status": "Unknown",
"outputFields": {"property1": null,
"property2": null
},
"lastUpdated": "2019-08-24T14:15:22Z",
"lastOperationRetried": 0,
"provider": "Unknown",
"lastOperationStatusMessage": "string",
"checksum": "string",
"systemMutationId": "dc2c0188-05a1-4004-9020-54751fd24915",
"errorCode": "string"
}
}

Response samples

200

Content type

text/plain

No sample

/LiveSystems/{resourceGroupId}/{liveSystemName}/components/{componentId} Deprecated

Authorizations:

Bearer

path Parameters

resourceGroupId required	string
liveSystemName required	string
componentId required	string

Request Body schema:
application/json

object (LiveSystemComponentDto)

displayName	string or null
description	string or null
type	string or null
id	string or null
version	string or null
locked	boolean
recreateOnFailure	boolean
	object or null
dependencies	Array of strings or null unique
	Array of objects or null (ComponentLinkDto)
status	string (LiveSystemComponentStatus) Enum: "Unknown" "Instantiating" "Active" "Failed" "Mutating" "Deleting" "Deleted" "Cancelled"
	object or null
lastUpdated	string <date-time>
lastOperationRetried	integer <int32>
provider	string (ProviderType) Enum: "Unknown" "AWS" "GCP" "Azure" "CaaS" "SaaS" "OCI" "Hetzner"
lastOperationStatusMessage	string or null
checksum	string or null <byte>
systemMutationId	string <uuid>
errorCode	string or null

Responses

Request samples

Payload

Content type

application/json

{"component": {"displayName": "string",
"description": "string",
"type": "string",
"id": "string",
"version": "string",
"locked": true,
"recreateOnFailure": true,
"parameters": {"property1": null,
"property2": null
},
"dependencies": ["string"
],
"links": [{"componentId": "string",
"settings": {"property1": null,
"property2": null
}
}
],
"status": "Unknown",
"outputFields": {"property1": null,
"property2": null
},
"lastUpdated": "2019-08-24T14:15:22Z",
"lastOperationRetried": 0,
"provider": "Unknown",
"lastOperationStatusMessage": "string",
"checksum": "string",
"systemMutationId": "dc2c0188-05a1-4004-9020-54751fd24915",
"errorCode": "string"
}
}

Response samples

200

Content type

text/plain

No sample

/LiveSystems/limits/subscriptions/{subscriptionId}

Authorizations:

Bearer

path Parameters

subscriptionId

required

string <uuid>

Request Body schema:
application/json

maxNumberOfLiveSystems	integer <int32>
maxNumberOfLiveSystemsComponents	integer <int32>

Responses

Request samples

Payload

Content type

application/json

{"maxNumberOfLiveSystems": 0,
"maxNumberOfLiveSystemsComponents": 0
}

RefeedLiveSystems

/livesystems/refeed

Authorizations:

Bearer

Request Body schema:
application/json

target	string or null
topicName	string or null
refeedId	string <uuid>

Responses

Request samples

Payload

Content type

application/json

{"target": "string",
"topicName": "string",
"refeedId": "dee4ce44-c98b-46f3-b1d9-7673b7143afc"
}

Fractal Live Systems (v1)

Health

/Health

Authorizations:

Responses

LiveSystems

/LiveSystems

Authorizations:

Request Body schema: application/jsontext/jsonapplication/*+jsonapplication/json

Responses

Request samples

Response samples

/LiveSystems

Authorizations:

Responses

Response samples

/LiveSystems/{resourceGroupType}/{resourceGroupOwnerId}/{resourceGroupShortName}/{liveSystemName}

Authorizations:

path Parameters

Request Body schema: application/jsontext/jsonapplication/*+jsonapplication/json

Responses

Request samples

Response samples

/LiveSystems/{resourceGroupType}/{resourceGroupOwnerId}/{resourceGroupShortName}/{liveSystemName}

Authorizations:

path Parameters

Responses

/LiveSystems/{resourceGroupType}/{resourceGroupOwnerId}/{resourceGroupShortName}/{liveSystemName}

Authorizations:

path Parameters

Responses

Response samples

/LiveSystems/{resourceGroupId}/{liveSystemName} Deprecated

Authorizations:

path Parameters

Request Body schema: application/jsontext/jsonapplication/*+jsonapplication/json

Responses

Request samples

Response samples

/LiveSystems/{resourceGroupId}/{liveSystemName} Deprecated

Authorizations:

path Parameters

Responses

/LiveSystems/{resourceGroupId}/{liveSystemName} Deprecated

Authorizations:

path Parameters

Responses

Response samples

/LiveSystems/{resourceGroupType}/{resourceGroupOwnerId}/{resourceGroupShortName}/{liveSystemName}/mutations/{mutationId}

Authorizations:

path Parameters

Responses

Response samples

/LiveSystems/{resourceGroupId}/{liveSystemName}/mutations/{mutationId} Deprecated

Authorizations:

path Parameters

Responses

Response samples

/LiveSystems/{resourceGroupType}/{resourceGroupOwnerId}/{resourceGroupShortName}/{liveSystemName}/component/{componentId}/instantiate

Authorizations:

path Parameters

Responses

Response samples

/LiveSystems/{resourceGroupId}/{liveSystemName}/component/{componentId}/instantiate Deprecated

Authorizations:

path Parameters

Responses

Response samples

/LiveSystems/{resourceGroupType}/{resourceGroupOwnerId}/{resourceGroupShortName}/{liveSystemName}/component/{componentId}/state/{mutationId}

Authorizations:

path Parameters

Responses

Response samples

/LiveSystems/{resourceGroupId}/{liveSystemName}/component/{componentId}/state/{mutationId} Deprecated

Authorizations:

path Parameters

Responses

Response samples

/LiveSystems/{resourceGroupType}/{resourceGroupOwnerId}/{resourceGroupShortName}/{liveSystemName}/components/{componentId}

Authorizations:

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json