Live Systems

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

• Health
  • get/Health
• LiveSystems
  • postInstantiate Live System
  • putUpdate Live System
  • delDelete Live System
  • getRetrieve Live System

API docs by Redocly

Fractal Live Systems (v1.0)

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

Instantiate Live System

Authorizations:

Bearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Command Request

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",
    • "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"

    },
  • "property2": {

    • "displayName": "string",
    • "description": "string",
    • "type": "string",
    • "id": "string",
    • "version": "string",
    • "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"

    }

  },
• "environment": {

  • "id": "string",
  • "displayName": "string",
  • "parentId": "string",
  • "parentType": "string"

  }

}

Response samples

• 200

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Update Live System

Authorizations:

Bearer

path Parameters

resourceGroupId required	string Resource Group Id
liveSystemName required	string Live System Name

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Update Command Request

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",
    • "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"

    },
  • "property2": {

    • "displayName": "string",
    • "description": "string",
    • "type": "string",
    • "id": "string",
    • "version": "string",
    • "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"

    }

  },
• "environment": {

  • "id": "string",
  • "displayName": "string",
  • "parentId": "string",
  • "parentType": "string"

  },
• "newResourceGroupId": "string",
• "newLiveSystemName": "string"

}

Response samples

• 200

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Delete Live System

Authorizations:

Bearer

path Parameters

resourceGroupId required	string Resource Group Id
liveSystemName required	string Live System Name

Responses

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

Retrieve Live System

Authorizations:

Bearer

path Parameters

resourceGroupId required	string Resource Group Id
liveSystemName required	string Live System Name

Responses

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

Response samples

• 200

Content type

text/plainapplication/jsontext/jsontext/plain

No sample