Live Systems

A Live System is the result of a specific instantiation of a Fractal

• Health
  • get/Health
• LiveSystems
  • post/LiveSystems
  • get/LiveSystems
  • put/LiveSystems/{resourceGroupType}/{resourceGroupOwnerId}/{resourceGroupShortName}/{liveSystemName}
  • del/LiveSystems/{resourceGroupType}/{resourceGroupOwnerId}/{resourceGroupShortName}/{liveSystemName}
  • get/LiveSystems/{resourceGroupType}/{resourceGroupOwnerId}/{resourceGroupShortName}/{liveSystemName}
  • put/LiveSystems/{resourceGroupId}/{liveSystemName}
  • del/LiveSystems/{resourceGroupId}/{liveSystemName}
  • get/LiveSystems/{resourceGroupId}/{liveSystemName}
  • get/LiveSystems/{resourceGroupType}/{resourceGroupOwnerId}/{resourceGroupShortName}/{liveSystemName}/mutations/{mutationId}
  • get/LiveSystems/{resourceGroupId}/{liveSystemName}/mutations/{mutationId}
  • post/LiveSystems/{resourceGroupType}/{resourceGroupOwnerId}/{resourceGroupShortName}/{liveSystemName}/component/{componentId}/instantiate
  • post/LiveSystems/{resourceGroupId}/{liveSystemName}/component/{componentId}/instantiate
  • get/LiveSystems/{resourceGroupType}/{resourceGroupOwnerId}/{resourceGroupShortName}/{liveSystemName}/component/{componentId}/state/{mutationId}
  • get/LiveSystems/{resourceGroupId}/{liveSystemName}/component/{componentId}/state/{mutationId}
  • put/LiveSystems/{resourceGroupType}/{resourceGroupOwnerId}/{resourceGroupShortName}/{liveSystemName}/components/{componentId}
  • put/LiveSystems/{resourceGroupId}/{liveSystemName}/components/{componentId}
  • put/LiveSystems/limits/subscriptions/{subscriptionId}
• RefeedLiveSystems
  • post/livesystems/refeed

API docs by Redocly

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

https://docs.fractal.cloud/Health

LiveSystems

/LiveSystems

Authorizations:

Bearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

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

Responses

https://docs.fractal.cloud/LiveSystems

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/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/plainapplication/jsontext/jsontext/plain

No sample

/LiveSystems

Authorizations:

Bearer

Responses

https://docs.fractal.cloud/LiveSystems

Response samples

• 200

Content type

text/plainapplication/jsontext/jsontext/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/jsontext/jsonapplication/*+jsonapplication/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

https://docs.fractal.cloud/LiveSystems/{resourceGroupType}/{resourceGroupOwnerId}/{resourceGroupShortName}/{liveSystemName}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/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/plainapplication/jsontext/jsontext/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

https://docs.fractal.cloud/LiveSystems/{resourceGroupType}/{resourceGroupOwnerId}/{resourceGroupShortName}/{liveSystemName}

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

Authorizations:

Bearer

path Parameters

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

Responses

https://docs.fractal.cloud/LiveSystems/{resourceGroupType}/{resourceGroupOwnerId}/{resourceGroupShortName}/{liveSystemName}

Response samples

• 200

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

/LiveSystems/{resourceGroupId}/{liveSystemName} Deprecated

Authorizations:

Bearer

path Parameters

resourceGroupId required	string
liveSystemName required	string

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/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

https://docs.fractal.cloud/LiveSystems/{resourceGroupId}/{liveSystemName}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/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/plainapplication/jsontext/jsontext/plain

No sample

/LiveSystems/{resourceGroupId}/{liveSystemName} Deprecated

Authorizations:

Bearer

path Parameters

resourceGroupId required	string
liveSystemName required	string

Responses

https://docs.fractal.cloud/LiveSystems/{resourceGroupId}/{liveSystemName}

/LiveSystems/{resourceGroupId}/{liveSystemName} Deprecated

Authorizations:

Bearer

path Parameters

resourceGroupId required	string
liveSystemName required	string

Responses

https://docs.fractal.cloud/LiveSystems/{resourceGroupId}/{liveSystemName}

Response samples

• 200

Content type

text/plainapplication/jsontext/jsontext/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

https://docs.fractal.cloud/LiveSystems/{resourceGroupType}/{resourceGroupOwnerId}/{resourceGroupShortName}/{liveSystemName}/mutations/{mutationId}

Response samples

• 200

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

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

Authorizations:

Bearer

path Parameters

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

Responses

https://docs.fractal.cloud/LiveSystems/{resourceGroupId}/{liveSystemName}/mutations/{mutationId}

Response samples

• 200

Content type

text/plainapplication/jsontext/jsontext/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

https://docs.fractal.cloud/LiveSystems/{resourceGroupType}/{resourceGroupOwnerId}/{resourceGroupShortName}/{liveSystemName}/component/{componentId}/instantiate

Response samples

• 200

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

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

Authorizations:

Bearer

path Parameters

resourceGroupId required	string
liveSystemName required	string
componentId required	string

Responses

https://docs.fractal.cloud/LiveSystems/{resourceGroupId}/{liveSystemName}/component/{componentId}/instantiate

Response samples

• 200

Content type

text/plainapplication/jsontext/jsontext/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

https://docs.fractal.cloud/LiveSystems/{resourceGroupType}/{resourceGroupOwnerId}/{resourceGroupShortName}/{liveSystemName}/component/{componentId}/state/{mutationId}

Response samples

• 200

Content type

text/plainapplication/jsontext/jsontext/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

https://docs.fractal.cloud/LiveSystems/{resourceGroupId}/{liveSystemName}/component/{componentId}/state/{mutationId}

Response samples

• 200

Content type

text/plainapplication/jsontext/jsontext/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/jsontext/jsonapplication/*+jsonapplication/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

https://docs.fractal.cloud/LiveSystems/{resourceGroupType}/{resourceGroupOwnerId}/{resourceGroupShortName}/{liveSystemName}/components/{componentId}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/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/plainapplication/jsontext/jsontext/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/jsontext/jsonapplication/*+jsonapplication/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

https://docs.fractal.cloud/LiveSystems/{resourceGroupId}/{liveSystemName}/components/{componentId}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/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/plainapplication/jsontext/jsontext/plain

No sample

/LiveSystems/limits/subscriptions/{subscriptionId}

Authorizations:

Bearer

path Parameters

subscriptionId required

string <uuid>

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

maxNumberOfLiveSystems	integer <int32>
maxNumberOfLiveSystemsComponents	integer <int32>

Responses

https://docs.fractal.cloud/LiveSystems/limits/subscriptions/{subscriptionId}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "maxNumberOfLiveSystems": 0,
• "maxNumberOfLiveSystemsComponents": 0

}

RefeedLiveSystems

/livesystems/refeed

Authorizations:

Bearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

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

Responses

https://docs.fractal.cloud/livesystems/refeed

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

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

}