3. Server API
3.1. remote_run
| Username | ||
| description | User account ID. Required if data is encrypted. |
|
| type | string |
|
| regex match | ^[^\s;]*$ |
|
| Authentication Key | ||
| description | Base64-encoded decryption key for the user account’s public key. Required if the uploaded data is encrypted. |
|
| type | string |
|
| Job Hash | ||
| description | UUID associated with the previously-imported project data. |
|
| type | string |
|
| regex match | ^[0-9a-f]{32}$ |
|
Schema for metadata required to remotely run a siliconcompiler job stage.
3.2. check_user
| Username | ||
| description | User account identifier. |
|
| type | string |
|
| regex match | ^[^\s;]*$ |
|
| Authentication Key | ||
| description | Key/password for the user’s account. |
|
| type | string |
|
Schema describing parameters for checking on a given user account.
3.3. delete_job
| Username | ||
| description | User account ID. Required for authentication if the data was originally imported by a valid user. |
|
| type | string |
|
| regex match | ^[^\s;]*$ |
|
| Authentication Key | ||
| description | Base64-encoded decryption key for the user account’s public key. Required if ‘username’ is provided. |
|
| type | string |
|
| Job Hash | ||
| description | UUID associated with the data that should be deleted. |
|
| type | string |
|
| regex match | ^[0-9a-f]{32}$ |
|
Schema describing parameters for deleting project data from remote storage.
3.4. get_results/{job_hash}.tar.gz
| Username | ||
| description | User account ID. Required for authentication if the job was originally created by a valid user. |
|
| type | string |
|
| regex match | ^[^\s;]*$ |
|
| Authentication Key | ||
| description | Base64-encoded decryption key for the user account’s public key. Required if ‘username’ is provided. |
|
| type | string |
|
Schema describing parameters for checking the progress of an ongoing job.
3.5. check_progress
| Username | ||
| description | User account ID. Required for authentication if the job was originally created by a valid user. |
|
| type | string |
|
| regex match | ^[^\s;]*$ |
|
| Authentication Key | ||
| description | Base64-encoded decryption key for the user account’s public key. Required if ‘username’ is provided. |
|
| type | string |
|
| Job Hash | ||
| description | UUID associated with the data that the job is operating on. |
|
| type | string |
|
| regex match | ^[0-9a-f]{32}$ |
|
| Job ID | ||
| description | ID associated with the ‘job_hash’ and the individual job that is being checked on. |
|
| type | string |
|
Schema describing parameters for checking the progress of an ongoing job.