+ + +
+ +The API reference is an interactive list of all API endpoints and includes request and response payload examples to test requests in the browser. + +:::info +The API requires authentication with a Platform access token to perform requests. + + +::: + +The API and its interactive reference is built on the OpenAPI standard. +Download the current OpenAPI schema file [here](https://cloud.seqera.io/openapi/seqera-api-latest.yml). + +:::tip +For more information on the OpenAPI standard, see [OpenAPI](https://swagger.io/specification/). +::: + +### Encoding and formatting standards + +- The API can be accessed from `https://api.cloud.seqera.io`. +- All API endpoints use HTTPS, and all request and response payloads use [JSON](https://www.json.org/) encoding. +- All timestamps use the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) date-time standard format: `YYYY-MM-DDTHH:MM:SSZ`. + +:::note +From version 23.4, the Platform API is live on `https://api.cloud.seqera.io`. The legacy API `https://api.tower.nf` remains fully operational, so existing API integrations will continue to perform as expected. Deprecation of the legacy API will be communicated well in advance to avoid any breaking changes to your integrations. +::: + +### Programmatic API + +Both the [Seqera Platform CLI](../cli/overview) and [seqerakit](https://github.com/seqeralabs/seqera-kit) are built on the Platform API and provide a programmatic automation layer for operations. + +You can also use tools such as [openapi-python-client](https://github.com/openapi-generators/openapi-python-client) to generate your own programmatic API for a particular language (such as Python) based on the OpenAPI schema. However, we do not guarantee that any OpenAPI client generators will work with the Platform API. + +### Authentication + +The API requires an authentication token to be specified in each API request using the +[Bearer](https://swagger.io/docs/specification/authentication/bearer-authentication) HTTP header. + +Once created, use your access token to authenticate requests to the API via cURL, Postman, or within your code. + + + +:::note +The token is only displayed once when it is created. Store your token in a safe place. +::: + +### cURL example + +```bash +curl -H "Authorization: Bearer eyJ...YTk0" https://api.cloud.seqera.io/workflow +``` + +:::info +Your access token must be included in every API call. +::: + +### Parameters + +Some API `GET` methods will accept standard `query` parameters, which are defined in the documentation. Optional parameters such as page size, number (when available), and file name can be submitted as query parameters. `POST`, `PUT`, and `DELETE` requests require additional parameters to be provided in your request body. + +Several head parameters are also accepted, such as `Authorization` for bearer access tokens or `Accept-Version` to indicate the desired API version to use (default version 1): + +```bash +curl -H "Authorization: Bearer QH..E5M=" + -H "Accept-Version:1" + -X POST https://api.cloud.seqera.io/domain/{item_id}?queryString={value} + -d { params: { "key":"value" } } + +``` + +### Client errors + +Two typical standard errors (i.e., response statuses other than `200` or `204`) are returned by the API. + +#### Bad Request + +The request payload is not properly defined or the query parameters are invalid. + +```json +{ + "message": "Unexpected error while processing - Error ID: 54apnFENQxbvCr23JaIjLb" +} +``` + +#### Forbidden + +Your access token is invalid or expired. This response may also imply that the endpoint you are trying to access is not available. Check your request syntax for typos, and confirm that your access token is valid. + +```bash +Status: 403 Forbidden +``` + +### Rate limiting + +For all API requests, there is a limit of 20 calls per second, per access token (72000 calls per hour). diff --git a/platform-enterprise/cli/_images/tw-info.jpg b/platform-enterprise/cli/_images/tw-info.jpg new file mode 100644 index 000000000..c3fc7a53a Binary files /dev/null and b/platform-enterprise/cli/_images/tw-info.jpg differ diff --git a/platform-enterprise/cli/_images/tw-screenshot.png b/platform-enterprise/cli/_images/tw-screenshot.png new file mode 100644 index 000000000..0cce6f21e Binary files /dev/null and b/platform-enterprise/cli/_images/tw-screenshot.png differ diff --git a/platform-enterprise/cli/commands.md b/platform-enterprise/cli/commands.md new file mode 100644 index 000000000..956ccfacf --- /dev/null +++ b/platform-enterprise/cli/commands.md @@ -0,0 +1,1200 @@ +--- +title: "Commands" +description: "Seqera Platform CLI commands." +date: "16 Jul 2024" +tags: [cli, commands] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +:::note +The CLI performs operations in the user workspace context by default. Use the `TOWER_WORKSPACE_ID` environment variable or the `--workspace` parameter to specify an organization workspace ID. +::: + +Use the `-h` or `--help` parameter to list the available commands and their associated options. + +[](https://github.com/seqeralabs/tower-cli) + +For help with a specific subcommand, run the command with `-h` or `--help` appended. For example, `tw credentials add google -h`. + +:::tip +Use `tw --output=json{method}: {file_path}
")) + else: + display(HTML(f"{method}: File not found at {file_path}
")) + ``` + +1. Visualize structures: + + ```python + valid_pdb_files = {method: file_path for method, file_path in pdb_files.items() if os.path.exists(file_path)} + + if valid_pdb_files: + display(HTML("No valid PDB files found. Please check the file paths and ensure that the files exist.
")) + ``` + +1. Add interactive elements: + + ```python + if valid_pdb_files: + method_dropdown = widgets.Dropdown( + options=[method for method, file in valid_pdb_files.items()], + description='Select method:', + disabled=False, + ) + + info_output = widgets.Output() + + def on_change(change): + with info_output: + info_output.clear_output() + selected_method = change['new'] + selected_file = valid_pdb_files[selected_method] + print(f"Selected method: {selected_method}") + print(f"File path: {selected_file}") + print(f"File size: {os.path.getsize(selected_file) / 1024:.2f} KB") + + method_dropdown.observe(on_change, names='value') + + display(HTML("