Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
93 changes: 85 additions & 8 deletions README.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Activity.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ Name | Type | Description | Notes
**projectId** | **String** | Unique identifier for project if applicable | [optional]
**instanceId** | **String** | Unique identifier for instance if applicable | [optional]
**createdAt** | **String** | Timestamp of when the activity was created | [optional]
**updatedAt** | **String** | Timestamp of the activity was last updated | [optional]
**updatedAt** | **String** | Timestamp of when the activity was last updated | [optional]


4 changes: 2 additions & 2 deletions docs/ActivityRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Name | Type | Description | Notes
**project** | **String** | Instance identifier used to filter instance resources | [optional]
**actor** | **String** | Actor identifier used to filter actor resources | [optional]
**search** | **String** | Last filter applied and is a fuzzy match on results | [optional]
**to** | **String** | Date to filter to, keyed off of createdAt, defaults to now | [optional]
**from** | **String** | Date to filter from, keyed off of createdAt, defaults to 1 week ago | [optional]
**to** | **String** | Date to filter to, keyed off of createdAt | [optional]
**from** | **String** | Date to filter from, keyed off of createdAt | [optional]


2 changes: 2 additions & 0 deletions docs/AgentApp.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,7 @@ Name | Type | Description | Notes
**applicationType** | **String** | | [optional]
**name** | **String** | | [optional]
**bundleID** | **String** | | [optional]
**bundlePath** | **String** | | [optional]
**bundleDataPath** | **String** | | [optional]


9 changes: 9 additions & 0 deletions docs/AllowedDomainsResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# CorelliumClient.AllowedDomainsResponse

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**allowedDomains** | **[String]** | List of allowed domains | [optional]


13 changes: 13 additions & 0 deletions docs/AssessmentHistory.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# CorelliumClient.AssessmentHistory

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**total** | **Number** | Total number of items |
**count** | **Number** | Number of items in current response |
**limit** | **Number** | Limit used for the request |
**offset** | **Number** | Offset used for the request |
**results** | [**[AssessmentHistoryLineItem]**](AssessmentHistoryLineItem.md) | The list of assessments |


11 changes: 11 additions & 0 deletions docs/AssessmentHistoryLineItem.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# CorelliumClient.AssessmentHistoryLineItem

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**date** | **Number** | UNIX Date representing the month |
**complete** | **Number** | The number of successful assessments |
**incomplete** | **Number** | The number of failed assessments |


10 changes: 10 additions & 0 deletions docs/AttachInterfaceRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# CorelliumClient.AttachInterfaceRequest

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**interfaceId** | **String** | Interface identifier |
**interconnectId** | **String** | Interconnect identifier |


10 changes: 10 additions & 0 deletions docs/ClusterConfigurationPayload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# CorelliumClient.ClusterConfigurationPayload

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**snapshotLimit** | **Number** | Designates the maximum number of snapshots that can be taken in a cluster | [optional]
**coordinatorConfig** | [**CoordinatorConfig**](CoordinatorConfig.md) | | [optional]


9 changes: 9 additions & 0 deletions docs/ClusterSnapshot.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# CorelliumClient.ClusterSnapshot

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**identifier** | **String** | Unique identifier for the snapshot | [optional]


2 changes: 2 additions & 0 deletions docs/ConfigResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**onSite** | **Boolean** | Denotes whether it's an on-site install | [optional]
**networkTypes** | **[String]** | Valid network types (e.g. \"nat\", \"bridged\", \"routed\") | [optional]
**networkType** | **String** | Current network type setting | [optional]
**showDomainSettings** | **Boolean** | Denotes whether to show domain settings | [optional]
**version** | **String** | Denotes the version | [optional]
**invalidBuild** | **Boolean** | Denotes whether the build is invalid | [optional]
Expand Down
9 changes: 9 additions & 0 deletions docs/CoordinatorConfig.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# CorelliumClient.CoordinatorConfig

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**usbMediaAccessEnabled** | **Boolean** | Designates the maximum number of snapshots that can be taken in a cluster | [optional]


3,139 changes: 2,585 additions & 554 deletions docs/CorelliumApi.md

Large diffs are not rendered by default.

24 changes: 24 additions & 0 deletions docs/CreateInterconnectRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# CorelliumClient.CreateInterconnectRequest

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | The name of the interconnect | [optional]
**protocol** | **String** | The protocol used by the interconnect | [optional]
**type** | **String** | The type of interconnect | [optional]
**project** | **String** | The UUID of the project | [optional]
**interfaces** | **[String]** | Array of instance identifiers | [optional]



## Enum: TypeEnum


* `hub` (value: `"hub"`)

* `switch` (value: `"switch"`)




9 changes: 9 additions & 0 deletions docs/DetachInterfaceRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# CorelliumClient.DetachInterfaceRequest

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**interconnectId** | **String** | Interconnect identifier |


17 changes: 17 additions & 0 deletions docs/Device.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# CorelliumClient.Device

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **String** | |
**model** | **String** | |
**name** | **String** | |
**platform** | **String** | | [optional]
**hwmodel** | **String** | | [optional]
**bdid** | **String** | | [optional]
**cpid** | **String** | | [optional]
**createdAt** | **String** | | [optional]
**updatedAt** | **String** | | [optional]


10 changes: 10 additions & 0 deletions docs/ExtendedFirmwareAssetInfo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# CorelliumClient.ExtendedFirmwareAssetInfo

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**firmwares** | **[String]** | Firmware Records from FW Service |
**instances** | **[String]** | Instances using one of the firmwares, and thus the asset |


18 changes: 18 additions & 0 deletions docs/FirmwareAsset.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# CorelliumClient.FirmwareAsset

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**domain** | **String** | |
**url** | **String** | |
**payload** | **String** | |
**size** | **Number** | |
**md5sum** | **String** | | [optional]
**sha1sum** | **String** | | [optional]
**sha256sum** | **String** | | [optional]
**uploaddate** | **String** | | [optional]
**createdAt** | **String** | | [optional]
**updatedAt** | **String** | | [optional]


13 changes: 13 additions & 0 deletions docs/FirmwareServiceConfiguration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# CorelliumClient.FirmwareServiceConfiguration

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**cacheFirmware** | **Boolean** | Cache Firmwares in /var/ipsw | [optional]
**clusterFirmwareAssets** | **Boolean** | Assets are cluster-wide | [optional]
**fallbackOriginalUrl** | **Boolean** | Use original URL to fetch firmware | [optional]
**fetchFirmwareAssets** | **Boolean** | Automatically fetch assets | [optional]
**shouldDownload** | **Boolean** | Download firmwares | [optional]


13 changes: 13 additions & 0 deletions docs/GetInterconnectsResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# CorelliumClient.GetInterconnectsResponse

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**results** | [**[InterconnectResponse]**](InterconnectResponse.md) | Array of interconnects | [optional]
**count** | **Number** | Number of interconnects in this response | [optional]
**total** | **Number** | Total number of interconnects | [optional]
**limit** | **Number** | Limit used for pagination | [optional]
**offset** | **Number** | Offset used for pagination | [optional]


13 changes: 13 additions & 0 deletions docs/GetStorageResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# CorelliumClient.GetStorageResponse

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**results** | [**[MediaStore]**](MediaStore.md) | Array of storage devices | [optional]
**count** | **Number** | Number of storage devices in this response | [optional]
**total** | **Number** | Total number of storage devices | [optional]
**limit** | **Number** | Limit used for pagination | [optional]
**offset** | **Number** | Offset used for pagination | [optional]


9 changes: 9 additions & 0 deletions docs/InstallFirmwareAssetsRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# CorelliumClient.InstallFirmwareAssetsRequest

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**imageId** | **String** | Image ID |


9 changes: 9 additions & 0 deletions docs/InstallFirmwareAssetsResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# CorelliumClient.InstallFirmwareAssetsResponse

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**taskId** | **String** | Task ID | [optional]


10 changes: 10 additions & 0 deletions docs/InstallFirmwareRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# CorelliumClient.InstallFirmwareRequest

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**imageId** | **String** | Image ID |
**filename** | **String** | Filename of the firmware |


10 changes: 10 additions & 0 deletions docs/InstallFirmwareResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# CorelliumClient.InstallFirmwareResponse

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**taskId** | **String** | Task ID | [optional]
**installedFirmwareUrl** | **String** | Installed Firmware URL | [optional]


2 changes: 1 addition & 1 deletion docs/Instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Name | Type | Description | Notes
**bootOptions** | [**InstanceBootOptions**](InstanceBootOptions.md) | | [optional]
**serviceIp** | **String** | Services IP Address | [optional]
**wifiIp** | **String** | LAN IP Address | [optional]
**secondaryIp** | **String** | Secondary Inteface LAN IP Address (if supported) | [optional]
**secondaryIp** | **String** | Secondary Interface LAN IP Address (if supported) | [optional]
**services** | [**InstanceServices**](InstanceServices.md) | | [optional]
**panicked** | **Boolean** | | [optional]
**created** | **Date** | Time instance was created | [optional]
Expand Down
1 change: 1 addition & 0 deletions docs/InstanceBootOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,6 @@ Name | Type | Description | Notes
**pac** | **Boolean** | Enable PAC | [optional]
**aprr** | **Boolean** | Enable APRR | [optional]
**additionalTags** | [**[InstanceBootOptionsAdditionalTag]**](InstanceBootOptionsAdditionalTag.md) | | [optional]
**kernel** | [**InstanceBootOptionsKernel**](InstanceBootOptionsKernel.md) | | [optional]


9 changes: 9 additions & 0 deletions docs/InstanceBootOptionsKernel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# CorelliumClient.InstanceBootOptionsKernel

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**firmwarePath** | **String** | The relative path within the firmware to the kernel file that has been bundled up with the selected firmware | [optional]


5 changes: 1 addition & 4 deletions docs/InstanceCreateOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,6 @@ Name | Type | Description | Notes
**origFwPackageUrl** | **String** | URL that firmware package used to create this instance is available at | [optional]
**encrypt** | **Boolean** | | [optional]
**wifiMac** | **String** | | [optional]
**volume** | [**VolumeOptions**](VolumeOptions.md) | | [optional]
**snapshot** | **String** | Snapshot ID for this instance to be cloned from if defined | [optional]
**bootOptions** | [**InstanceBootOptions**](InstanceBootOptions.md) | | [optional]
**device** | [**Model**](Model.md) | | [optional]
**wanAccess** | **Boolean** | manages internet access | [optional]


10 changes: 10 additions & 0 deletions docs/InstanceInterface.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# CorelliumClient.InstanceInterface

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**deviceId** | **String** | The instance id | [optional]
**interfaceId** | **String** | The interface id | [optional]


28 changes: 28 additions & 0 deletions docs/InterconnectResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# CorelliumClient.InterconnectResponse

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | The interconnect identifier | [optional]
**name** | **String** | The name of the interconnect | [optional]
**protocol** | **String** | The protocol used by the interconnect | [optional]
**type** | **String** | The type of interconnect | [optional]
**project** | **String** | The UUID of the project | [optional]
**status** | **String** | The current status of the interconnect | [optional]
**interfaces** | [**[InstanceInterface]**](InstanceInterface.md) | Array of instance interfaces | [optional]
**createdAt** | **String** | Creation timestamp | [optional]
**updatedAt** | **String** | Last update timestamp | [optional]



## Enum: TypeEnum


* `hub` (value: `"hub"`)

* `switch` (value: `"switch"`)




19 changes: 19 additions & 0 deletions docs/MediaStore.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# CorelliumClient.MediaStore

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**identifier** | **String** | | [optional]
**device** | **String** | | [optional]
**fsType** | **String** | | [optional]
**fsUUID** | **String** | | [optional]
**label** | **String** | | [optional]
**serial** | **String** | | [optional]
**vendor** | **String** | | [optional]
**model** | **String** | | [optional]
**mountPolicy** | **String** | | [optional]
**createdAt** | **String** | | [optional]
**updatedAt** | **String** | | [optional]


13 changes: 13 additions & 0 deletions docs/NodeInformation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# CorelliumClient.NodeInformation

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**nodeId** | **String** | Unique identifier for the node |
**address** | **String** | IP address of the node |
**hostname** | **String** | Hostname of the node |
**sshPort** | **Number** | SSH port for the node | [optional]
**nodeTypes** | **[String]** | Types of services running on this node [compute,controller,gpu] |


Loading