### Start Make CLI Login Wizard Source: https://developers.make.com/make-cli/make-cli/authenticate-the-make-cli Run this command to initiate the login wizard for authenticating the Make CLI. The wizard guides you through selecting your zone, creating an API key if needed, and entering your API key. ```bash make-cli login ``` -------------------------------- ### Example of running Make CLI with npx Source: https://developers.make.com/make-cli/make-cli/install-the-make-cli An example demonstrating how to list scenarios using the Make CLI via npx. Replace `123` with your actual team ID. ```bash npx @makehq/cli scenarios list --team-id=123 ``` -------------------------------- ### Install Make CLI via npm Source: https://developers.make.com/make-cli/make-cli/install-the-make-cli Use this command to globally install the Make CLI using npm. Ensure Node.js is installed. ```bash npm install -g @makehq/cli ``` -------------------------------- ### Example Make CLI Command Source: https://developers.make.com/make-cli/make-cli/make-cli-reference An example of a Make CLI command to list scenarios in a specific zone and team. ```shellscript make-cli --zone eu2.make.com scenarios list --team-id=1 ``` -------------------------------- ### Install Make CLI via Homebrew Source: https://developers.make.com/make-cli/make-cli/install-the-make-cli Install the Make CLI on macOS and Linux systems using the Homebrew package manager. ```bash brew install make-cli integromat/tap/make-cli ``` -------------------------------- ### Install Make CLI via .deb package Source: https://developers.make.com/make-cli/make-cli/install-the-make-cli Install the Make CLI on Linux systems using a .deb package. Ensure you replace the filename with the one matching your system's architecture. ```bash sudo dpkg -i make-cli-linux-amd64.deb ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/account-management To get more information not present on the current page, perform an HTTP GET request to the page URL with the 'ask' query parameter. The question should be specific and self-contained. ```http GET https://developers.make.com/make-cli/make-cli/make-cli-reference/account-management.md?ask= ``` -------------------------------- ### make-cli sdk-webhooks get Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/custom-app-development Get a single webhook by name. ```APIDOC ## GET /api/sdk/webhooks/get ### Description Get a single webhook by name. ### Method GET ### Endpoint /api/sdk/webhooks/get ### Parameters #### Query Parameters - **--webhook-name** (string) - Required - The name of the webhook ### Request Example ```bash make-cli sdk-webhooks get --webhook-name=my-app ``` ``` -------------------------------- ### Get App Documentation with Make CLI Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/custom-app-development Use this command to retrieve the readme documentation for a specific app version. Requires app name and version. ```bash make-cli sdk-apps get-docs --name=my-app --version=1 ``` -------------------------------- ### Make CLI SDK Apps Get Docs Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/custom-app-development Retrieves the documentation (readme) for a specific application. ```APIDOC ## make-cli sdk-apps get-docs ### Description Get app documentation (readme). ### Method CLI Command ### Endpoint N/A (CLI command) ### Parameters #### Query Parameters - **--name** (string) - Required - The name of the app - **--version** (string) - Required - The version of the app ### Request Example ```bash make-cli sdk-apps get-docs --name=my-app --version=1 ``` ### Response #### Success Response (200) - **documentation** (string) - The markdown content of the app's readme. #### Response Example ```json { "documentation": "# My App\n\nThis is the readme content." } ``` ``` -------------------------------- ### Query Documentation Dynamically Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/custom-app-development Perform an HTTP GET request on the current page URL with the 'ask' query parameter to get additional information not directly present on the page. The question should be specific and self-contained. ```http GET https://developers.make.com/make-cli/make-cli/make-cli-reference/custom-app-development.md?ask= ``` -------------------------------- ### Query Documentation Index Source: https://developers.make.com/make-cli Perform an HTTP GET request to the documentation index with the 'ask' parameter to get a direct answer to a specific question, along with relevant excerpts and sources. ```http GET https://developers.make.com/make-developer-hub.md?ask= ``` -------------------------------- ### Get SDK App by Name and Version with Make CLI Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/custom-app-development Retrieve a specific SDK app by providing its name and version. Both `--name` and `--version` are required. ```bash make-cli sdk-apps get --name=my-app --version=1 ``` -------------------------------- ### Query Make CLI Documentation Source: https://developers.make.com/make-cli/make-cli/install-the-make-cli Perform an HTTP GET request to query the Make CLI documentation dynamically. Append the `ask` query parameter with your question. ```http GET https://developers.make.com/make-cli/make-cli/install-the-make-cli.md?ask= ``` -------------------------------- ### Query Make CLI Documentation Source: https://developers.make.com/make-cli/make-cli/make-cli-reference Perform an HTTP GET request with the 'ask' query parameter to dynamically query the Make CLI documentation for specific information. ```http GET https://developers.make.com/make-cli/make-cli/make-cli-reference.md?ask= ``` -------------------------------- ### Querying Documentation Source: https://developers.make.com/make-cli/make-cli/make-cli-reference Dynamically query the Make CLI documentation by performing an HTTP GET request with an 'ask' query parameter. ```APIDOC ## Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://developers.make.com/make-cli/make-cli/make-cli-reference.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. ``` -------------------------------- ### Make CLI SDK Connections Get Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/custom-app-development Retrieves a single connection by its name. ```APIDOC ## make-cli sdk-connections get ### Description Get a single connection by name. ### Method CLI Command ### Endpoint N/A (CLI command) ### Parameters #### Query Parameters - **--connection-name** (string) - Required - The name of the connection ### Request Example ```bash make-cli sdk-connections get --connection-name=my-app ``` ### Response #### Success Response (200) - **connection** (object) - The connection object. - **name** (string) - The name of the connection. - **type** (string) - The type of the connection. - **label** (string) - The label of the connection. #### Response Example ```json { "connection": { "name": "my-connection", "type": "oauth2", "label": "OAuth 2.0" } } ``` ``` -------------------------------- ### Query Make CLI Documentation Dynamically Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/credentials Perform an HTTP GET request on the current page URL with the `ask` query parameter to retrieve specific information not explicitly present. The question should be specific and self-contained. ```http GET https://developers.make.com/make-cli/make-cli/make-cli-reference/credentials.md?ask= ``` -------------------------------- ### make-cli sdk-rpcs get-section Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/custom-app-development Get RPC section data. ```APIDOC ## GET /api/sdk/rpcs/get-section ### Description Get RPC section data. ### Method GET ### Endpoint /api/sdk/rpcs/get-section ### Parameters #### Query Parameters - **--app-name** (string) - Required - The name of the app - **--app-version** (string) - Required - The version of the app - **--rpc-name** (string) - Required - The name of the RPC - **--section** (string) - Required - The section to get ### Request Example ```bash make-cli sdk-rpcs get-section \ --app-name=my-app \ --app-version=1 \ --rpc-name=getFields \ --section=api ``` ``` -------------------------------- ### Perform HTTP GET Request to Query Documentation Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/scenarios Use this method to ask specific questions about the documentation. The response includes direct answers and relevant excerpts. ```http GET https://developers.make.com/make-cli/make-cli/make-cli-reference/scenarios.md?ask= ``` -------------------------------- ### Get Current User Details with Make CLI Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/account-management Retrieves details for the currently authenticated user. ```bash make-cli users me ``` -------------------------------- ### Get Organization Details with Make CLI Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/account-management Retrieves details for a specific organization. Requires the organization ID. ```bash make-cli organizations get --organization-id=5 ``` -------------------------------- ### Perform HTTP GET Request with 'ask' Parameter Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/data-stores Use this method to query documentation dynamically when information is not explicitly present or requires clarification. The question should be specific and self-contained. ```HTTP GET https://developers.make.com/make-cli/make-cli/make-cli-reference/data-stores.md?ask= ``` -------------------------------- ### Query Documentation Dynamically Source: https://developers.make.com/make-cli/make-cli/authenticate-the-make-cli Perform an HTTP GET request to a documentation URL with the `ask` query parameter to dynamically query the documentation. This is useful for retrieving specific information not explicitly present on the page. ```http GET https://developers.make.com/make-cli/make-cli/authenticate-the-make-cli.md?ask= ``` -------------------------------- ### Get Make Scenario by ID Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/scenarios Retrieve a specific scenario and its blueprint using its ID. Requires the scenario ID. ```bash make-cli scenarios get --scenario-id=925 ``` -------------------------------- ### Get Specific Connection Details with Make CLI Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/credentials Retrieves detailed information for a given connection ID. This command requires the `--connection-id` option. ```bash make-cli connections get --connection-id=2 ``` -------------------------------- ### Get make-cli execution details Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/scenarios Retrieve basic details of a specific scenario execution by providing the scenario ID and execution ID. ```bash make-cli executions get \ --scenario-id=925 \ --execution-id=a07e16f2ad134bf49cf83a00aa95c0a5 ``` -------------------------------- ### Get Single App Connection with Make CLI Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/custom-app-development Use this command to retrieve a single connection by its name. Requires the connection name. ```bash make-cli sdk-connections get --connection-name=my-app ``` -------------------------------- ### Get Specific Key Details with Make CLI Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/credentials Retrieves the details of a particular key using its ID. The `--key-id` option is required. ```bash make-cli keys get --key-id=1 ``` -------------------------------- ### Run Make CLI directly via npx Source: https://developers.make.com/make-cli/make-cli/install-the-make-cli Execute Make CLI commands without a global installation using npx. Replace `` with the desired Make CLI command. ```bash npx @makehq/cli ``` -------------------------------- ### Get App Common Data with Make CLI Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/custom-app-development Use this command to retrieve common data, including client credentials and shared configuration, for a specific app version. Requires app name and version. ```bash make-cli sdk-apps get-common --name=my-app --version=1 ``` -------------------------------- ### Get Single App Module with Make CLI Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/custom-app-development Retrieve details for a single app module by its name. Requires the app name, version, and the specific module name. ```bash make-cli sdk-modules get \ --app-name=my-app \ --app-version=1 \ --module-name=listItems ``` -------------------------------- ### Create a New SDK App with Make CLI Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/custom-app-development Initiate the creation of a new SDK app. Required options include name, label, theme, language, and audience. Description and countries are optional. ```bash make-cli sdk-apps create \ --name=my-app \ --label='My App' \ --description='A custom app' \ --theme=#FF5733 \ --language=en \ --audience=global ``` -------------------------------- ### Get Specific Section of SDK App with Make CLI Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/custom-app-development Retrieve a particular section of an SDK app by providing its name, version, and the section name. The `--section` parameter is mandatory. ```bash make-cli sdk-apps get-section --name=my-app --version=1 --section=base ``` -------------------------------- ### make-cli hooks get Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/scenarios Get details of a specific webhook/mailhook. ```APIDOC ## `make-cli hooks get` ### Description Get details of a specific webhook/mailhook. ### Method Not specified (CLI command) ### Endpoint Not specified (CLI command) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Options - `--hook-id` (string) - Required - The hook ID to retrieve ### Request Example ```bash make-cli hooks get --hook-id=11 ``` ### Response Success response provides details of the specified webhook/mailhook. Specific details not provided. #### Success Response (200) Not specified #### Response Example Not specified ``` -------------------------------- ### Make CLI Help Command Source: https://developers.make.com/make-cli/make-cli/make-cli-reference View all available commands and options for the Make CLI by running the --help command. ```bash make-cli --help ``` -------------------------------- ### List SDK Apps with Make CLI Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/custom-app-development Use this command to list all available SDK apps. Optional filtering can be applied. ```bash make-cli sdk-apps list ``` -------------------------------- ### Set App Documentation with Make CLI Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/custom-app-development Use this command to set the readme documentation for a specific app version. Requires app name, version, and markdown-formatted docs. ```bash make-cli sdk-apps set-docs \ --name=my-app \ --version=1 \ --docs='# My App This app integrates with the Example API.' ``` -------------------------------- ### Get SDK Module Section Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/custom-app-development Retrieves a specific section of an SDK module. You must specify the app name, version, module name, and the section you want to get. ```bash make-cli sdk-modules get-section \ --app-name=my-app \ --app-version=1 \ --module-name=listItems \ --section=api ``` -------------------------------- ### Querying Documentation Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/credentials To get additional information not directly available on a page, you can query the documentation dynamically by performing an HTTP GET request on the page URL with the `ask` query parameter. ```APIDOC ## GET https://developers.make.com/make-cli/make-cli/make-cli-reference/credentials.md?ask= ### Description This mechanism allows you to ask specific, self-contained questions in natural language to retrieve direct answers, relevant excerpts, and sources from the documentation. Use this when information is not explicitly present, requires clarification, or you need to retrieve related documentation sections. ### Parameters #### Query Parameters - **ask** (string) - Required - Your question in natural language. ``` -------------------------------- ### Make CLI SDK Connections List Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/custom-app-development Lists all connections for a specific application. ```APIDOC ## make-cli sdk-connections list ### Description List connections for a specific app. ### Method CLI Command ### Endpoint N/A (CLI command) ### Parameters #### Query Parameters - **--app-name** (string) - Required - The name of the app ### Request Example ```bash make-cli sdk-connections list --app-name=my-app ``` ### Response #### Success Response (200) - **connections** (array) - A list of connection objects. - **name** (string) - The name of the connection. - **type** (string) - The type of the connection. - **label** (string) - The label of the connection. #### Response Example ```json { "connections": [ { "name": "my-connection", "type": "oauth2", "label": "OAuth 2.0" } ] } ``` ``` -------------------------------- ### make-cli sdk-webhooks create Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/custom-app-development Create a new webhook for an app. ```APIDOC ## POST /api/sdk/webhooks/create ### Description Create a new webhook for an app. ### Method POST ### Endpoint /api/sdk/webhooks/create ### Parameters #### Query Parameters - **--app-name** (string) - Required - The name of the app - **--type** (string) - Required - The type of the webhook - **--label** (string) - Required - The label of the webhook visible in the scenario builder ### Request Example ```bash make-cli sdk-webhooks create --app-name=my-app --type=web --label='New Item' ``` ``` -------------------------------- ### Run a make-cli scenario with input data Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/scenarios Execute a scenario using its ID and provide optional input data. The `--responsive` flag can be used to run the scenario responsively. ```bash make-cli scenarios run --scenario-id=925 --data='{"name":"John"}' --responsive ``` -------------------------------- ### Get Scenario Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/scenarios Retrieves a specific scenario and its blueprint by its ID. ```APIDOC ## `make-cli scenarios get` ### Description Get a scenario and its blueprint by ID. ### Method GET ### Endpoint `/scenarios/{scenario-id}` ### Parameters #### Path Parameters - **scenario-id** (string) - Required - The scenario ID to retrieve. ### Request Example ```bash make-cli scenarios get --scenario-id=925 ``` ### Response #### Success Response (200) - **scenario_id** (string) - The ID of the scenario. - **name** (string) - The name of the scenario. - **team_id** (string) - The ID of the team the scenario belongs to. - **folder_id** (string) - The ID of the folder the scenario is in. - **created_at** (string) - The timestamp when the scenario was created. - **updated_at** (string) - The timestamp when the scenario was last updated. - **active** (boolean) - Indicates if the scenario is active. - **scheduling** (object) - The scheduling configuration for the scenario. - **blueprint** (object) - The blueprint containing the scenario configuration. #### Response Example ```json { "scenario_id": "925", "name": "My Scenario", "team_id": "5", "folder_id": "abc", "created_at": "2023-01-01T10:00:00Z", "updated_at": "2023-01-01T10:00:00Z", "active": true, "scheduling": { "type": "indefinitely", "interval": 60 }, "blueprint": { "name": "Example Blueprint", "flow": [], "metadata": {} } } ``` ``` -------------------------------- ### Create App Connection with Make CLI Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/custom-app-development Use this command to create a new connection for a specific app. Requires app name, connection type, and a visible label. ```bash make-cli sdk-connections create \ --app-name=my-app \ --type=oauth2 \ --label='OAuth 2.0' ``` -------------------------------- ### Get SDK App Section Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/custom-app-development Retrieves a specific section of a SDK app. ```APIDOC ## Get SDK App Section ### Description Get a specific section of a SDK app. ### Method GET ### Endpoint /sdk-apps/{name}/{version}/sections/{section} ### Parameters #### Path Parameters - **name** (string) - Required - The name of the app. - **version** (string) - Required - The version of the app. - **section** (string) - Required - The name of the section to retrieve (e.g., 'base', 'triggers', 'actions'). ### Request Example ```bash make-cli sdk-apps get-section --name=my-app --version=1 --section=base ``` ### Response #### Success Response (200) - **section_data** (object) - The content of the requested section. #### Response Example ```json { "section_data": { "baseUrl": "https://api.example.com" } } ``` ``` -------------------------------- ### List App Connections with Make CLI Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/custom-app-development Use this command to list all connections associated with a specific app. Requires the app name. ```bash make-cli sdk-connections list --app-name=my-app ``` -------------------------------- ### Get SDK App Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/custom-app-development Retrieves a specific SDK app by its name and version. ```APIDOC ## Get SDK App ### Description Get a SDK app by name and version. ### Method GET ### Endpoint /sdk-apps/{name}/{version} ### Parameters #### Path Parameters - **name** (string) - Required - The name of the app. - **version** (string) - Required - The version of the app. ### Request Example ```bash make-cli sdk-apps get --name=my-app --version=1 ``` ### Response #### Success Response (200) - **name** (string) - The name of the app. - **version** (string) - The version of the app. - **label** (string) - The label of the app. - **description** (string) - The description of the app. - **theme** (string) - The color theme of the app logo. - **language** (string) - The language of the app. - **countries** (array) - Countries where the app is available. - **private** (boolean) - Whether the app is private. - **audience** (string) - Audience setting for the app. #### Response Example ```json { "name": "my-app", "version": "1.0.0", "label": "My App", "description": "A custom app", "theme": "#FF5733", "language": "en", "countries": ["US", "CA"], "private": false, "audience": "global" } ``` ``` -------------------------------- ### Custom Functions API Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/scenarios Commands for managing custom functions, including listing, getting, creating. ```APIDOC ## GET make-cli functions list ### Description List custom functions for a team. ### Method GET ### Endpoint /functions/list ### Parameters #### Query Parameters - **--team-id** (string) - Required - The team ID to list functions for ### Request Example ```bash make-cli functions list --team-id=5 ``` ``` ```APIDOC ## GET make-cli functions get ### Description Get details of a specific custom function. ### Method GET ### Endpoint /functions/get ### Parameters #### Query Parameters - **--function-id** (string) - Required - The function ID to retrieve ### Request Example ```bash make-cli functions get --function-id=2 ``` ``` ```APIDOC ## POST make-cli functions create ### Description Create a new custom function. ### Method POST ### Endpoint /functions/create ### Parameters #### Query Parameters - **--team-id** (string) - Required - The team ID where the function will be created - **--name** (string) - Required - The name of the function - **--code** (string) - Required - The function code - **--description** (string) - Optional - Description of the function ### Request Example ```bash make-cli functions create \ --team-id=5 \ --name=checkType \ --code='function checkType(param) { return typeof param; }' \ --description='Returns the data type of the argument.' ``` ``` -------------------------------- ### Scenario Management API Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/scenarios Commands for interacting with scenarios, including running, getting interfaces, and setting interfaces. ```APIDOC ## POST /scenarios/run ### Description Execute a scenario with optional input data. ### Method POST ### Endpoint /scenarios/run ### Parameters #### Query Parameters - **scenario-id** (string) - Required - The scenario ID to run - **data** (string) - Optional - Optional input data for the scenario - **responsive** (boolean) - Optional - Whether to run responsively - **callback-url** (string) - Optional - URL to call once the scenario execution finishes ### Request Example ```bash make-cli scenarios run --scenario-id=925 --data='{"name":"John"}' --responsive ``` ## GET /scenarios/interface ### Description Get the interface for a scenario. ### Method GET ### Endpoint /scenarios/interface ### Parameters #### Query Parameters - **scenario-id** (string) - Required - The scenario ID to get the interface for ### Request Example ```bash make-cli scenarios interface --scenario-id=925 ``` ## PUT /scenarios/interface ### Description Update the interface for a scenario. ### Method PUT ### Endpoint /scenarios/interface ### Parameters #### Query Parameters - **scenario-id** (string) - Required - The scenario ID to update the interface for - **interface** (string) - Required - The interface definition with input and output specifications ### Request Example ```bash make-cli scenarios set-interface \ --scenario-id=925 \ --interface='{ "input": [ { "name": "myInput", "type": "text", "required": true } ], "output": [] }' ``` ``` -------------------------------- ### List Devices with make-cli Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/scenarios Use this command to list all devices registered within a specific team. ```bash make-cli devices list --team-id=5 ``` -------------------------------- ### List functions for an app Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/custom-app-development Lists all available functions associated with a specific app version. Requires the app name and app version. ```bash make-cli sdk-functions list --app-name=my-app --app-version=1 ``` -------------------------------- ### Get Team Details with Make CLI Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/account-management Retrieves details for a specific team. Requires the team ID. ```bash make-cli teams get --team-id=5 ``` -------------------------------- ### Get a Single App Webhook Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/custom-app-development Use this command to retrieve a single webhook by its name. The webhook name is required. ```bash make-cli sdk-webhooks get --webhook-name=my-app ``` -------------------------------- ### Make CLI SDK Apps Set Docs Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/custom-app-development Sets the documentation (readme) for a specific application. ```APIDOC ## make-cli sdk-apps set-docs ### Description Set app documentation (readme). ### Method CLI Command ### Endpoint N/A (CLI command) ### Parameters #### Query Parameters - **--name** (string) - Required - The name of the app - **--version** (string) - Required - The version of the app - **--docs** (string) - Required - The documentation content in markdown format ### Request Example ```bash make-cli sdk-apps set-docs \ --name=my-app \ --version=1 \ --docs='# My App\n\nThis app integrates with the Example API.' ``` ### Response #### Success Response (200) - **message** (string) - Confirmation message. #### Response Example ```json { "message": "App documentation updated successfully." } ``` ``` -------------------------------- ### Get common configuration for a connection Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/custom-app-development Retrieves the common configuration settings for a specified connection. Only the connection name is required. ```bash make-cli sdk-connections get-common --connection-name=my-app ``` -------------------------------- ### Test an SDK RPC Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/custom-app-development Use this command to test an RPC with provided data and schema. All parameters are required. ```bash make-cli sdk-rpcs test \ --app-name=my-app \ --app-version=1 \ --rpc-name=getFields \ --data='{"connectionId":2}' \ --schema='[{"name":"connectionId","type":"number","required":true}]' ``` -------------------------------- ### make-cli sdk-webhooks list Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/custom-app-development List webhooks for a specific app. ```APIDOC ## GET /api/sdk/webhooks/list ### Description List webhooks for a specific app. ### Method GET ### Endpoint /api/sdk/webhooks/list ### Parameters #### Query Parameters - **--app-name** (string) - Required - The name of the app ### Request Example ```bash make-cli sdk-webhooks list --app-name=my-app ``` ``` -------------------------------- ### Create a New App Webhook Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/custom-app-development Use this command to create a new webhook for an app. The app name, type, and label are required. ```bash make-cli sdk-webhooks create --app-name=my-app --type=web --label='New Item' ``` -------------------------------- ### Data Stores Management Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/data-stores Commands for managing data stores, including listing, getting, creating, updating, and deleting them. ```APIDOC ## `make-cli data-stores list` ### Description List all data stores for a team. ### Method GET ### Endpoint `/data-stores` ### Parameters #### Query Parameters - **team-id** (string) - Required - The team ID to filter data stores by ### Request Example ```bash make-cli data-stores list --team-id=5 ``` ### Response #### Success Response (200) - **dataStores** (array) - A list of data store objects. - **id** (string) - The unique identifier for the data store. - **name** (string) - The name of the data store. - **teamId** (string) - The ID of the team the data store belongs to. - **maxSizeMB** (integer) - The maximum size of the data store in megabytes. - **createdAt** (string) - The timestamp when the data store was created. - **updatedAt** (string) - The timestamp when the data store was last updated. #### Response Example ```json { "dataStores": [ { "id": "137", "name": "Customers", "teamId": "5", "maxSizeMB": 1, "createdAt": "2023-01-01T10:00:00Z", "updatedAt": "2023-01-01T10:00:00Z" } ] } ``` ``` ```APIDOC ## `make-cli data-stores get` ### Description Get data store details by ID. ### Method GET ### Endpoint `/data-stores/{dataStoreId}` ### Parameters #### Path Parameters - **data-store-id** (string) - Required - The data store ID to retrieve ### Request Example ```bash make-cli data-stores get --data-store-id=137 ``` ### Response #### Success Response (200) - **id** (string) - The unique identifier for the data store. - **name** (string) - The name of the data store. - **teamId** (string) - The ID of the team the data store belongs to. - **maxSizeMB** (integer) - The maximum size of the data store in megabytes. - **createdAt** (string) - The timestamp when the data store was created. - **updatedAt** (string) - The timestamp when the data store was last updated. #### Response Example ```json { "id": "137", "name": "Customers", "teamId": "5", "maxSizeMB": 1, "createdAt": "2023-01-01T10:00:00Z", "updatedAt": "2023-01-01T10:00:00Z" } ``` ``` ```APIDOC ## `make-cli data-stores create` ### Description Create a new data store. ### Method POST ### Endpoint `/data-stores` ### Parameters #### Request Body - **name** (string) - Required - Name of the data store - **teamId** (string) - Required - ID of the team to create the data store in - **maxSizeMB** (integer) - Required - Maximum size in MB for the data store - **datastructureId** (string) - Optional - ID of the data structure defining the record format ### Request Example ```bash make-cli data-stores create \ --name=Customers \ --team-id=5 \ --max-size-m-b=1 \ --datastructure-id=178 ``` ### Response #### Success Response (201) - **id** (string) - The unique identifier for the newly created data store. - **name** (string) - The name of the data store. - **teamId** (string) - The ID of the team the data store belongs to. - **maxSizeMB** (integer) - The maximum size of the data store in megabytes. - **createdAt** (string) - The timestamp when the data store was created. - **updatedAt** (string) - The timestamp when the data store was last updated. #### Response Example ```json { "id": "138", "name": "Customers", "teamId": "5", "maxSizeMB": 1, "createdAt": "2023-01-02T11:00:00Z", "updatedAt": "2023-01-02T11:00:00Z" } ``` ``` ```APIDOC ## `make-cli data-stores update` ### Description Update a data store. ### Method PUT ### Endpoint `/data-stores/{dataStoreId}` ### Parameters #### Path Parameters - **data-store-id** (string) - Required - The data store ID to update #### Request Body - **name** (string) - Optional - New name for the data store - **maxSizeMB** (integer) - Optional - New maximum size in MB for the data store - **datastructureId** (string) - Optional - New data structure ID ### Request Example ```bash make-cli data-stores update \ --data-store-id=137 \ --name='Updated Store' \ --max-size-m-b=2 ``` ### Response #### Success Response (200) - **id** (string) - The unique identifier for the updated data store. - **name** (string) - The updated name of the data store. - **teamId** (string) - The ID of the team the data store belongs to. - **maxSizeMB** (integer) - The updated maximum size of the data store in megabytes. - **createdAt** (string) - The timestamp when the data store was created. - **updatedAt** (string) - The timestamp when the data store was last updated. #### Response Example ```json { "id": "137", "name": "Updated Store", "teamId": "5", "maxSizeMB": 2, "createdAt": "2023-01-01T10:00:00Z", "updatedAt": "2023-01-02T12:00:00Z" } ``` ``` ```APIDOC ## `make-cli data-stores delete` ### Description Delete a data store. ### Method DELETE ### Endpoint `/data-stores/{dataStoreId}` ### Parameters #### Path Parameters - **data-store-id** (string) - Required - The data store ID to delete ### Request Example ```bash make-cli data-stores delete --data-store-id=137 ``` ### Response #### Success Response (204) No content is returned upon successful deletion. ``` -------------------------------- ### List Make Scenarios Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/scenarios Use this command to list all scenarios for a specific team. Requires the team ID. ```bash make-cli scenarios list --team-id=5 ``` -------------------------------- ### Get Data Store Details Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/data-stores Retrieves details for a specific data store. Requires the data store ID. ```bash make-cli data-stores get --data-store-id=137 ``` -------------------------------- ### Get SDK RPC Section Data Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/custom-app-development Use this command to retrieve specific section data for an RPC. All parameters are required. ```bash make-cli sdk-rpcs get-section \ --app-name=my-app \ --app-version=1 \ --rpc-name=getFields \ --section=api ``` -------------------------------- ### Create Organization with Make CLI Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/account-management Creates a new organization. Requires the organization name, region ID, timezone ID, and country ID. ```bash make-cli organizations create \ --name='My Organization' \ --region-id=1 \ --timezone-id=113 \ --country-id=1 ``` -------------------------------- ### Get Webhook/Mailhook Details with make-cli Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/scenarios Use this command to retrieve detailed information about a specific webhook or mailhook using its ID. ```bash make-cli hooks get --hook-id=11 ``` -------------------------------- ### Get a Webhook Section with make-cli Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/custom-app-development Use this command to retrieve a specific section of a webhook. Both the webhook name and the section name are required. ```bash make-cli sdk-webhooks get-section --webhook-name=my-app --section=api ``` -------------------------------- ### Get function code Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/custom-app-development Retrieves the source code for a specific function. Requires app name, app version, and function name. ```bash make-cli sdk-functions get-code \ --app-name=my-app \ --app-version=1 \ --function-name=parseDate ``` -------------------------------- ### make-cli devices list Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/scenarios List devices registered in a team. ```APIDOC ## `make-cli devices list` ### Description List devices registered in a team. ### Method Not specified (CLI command) ### Endpoint Not specified (CLI command) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Options - `--team-id` (string) - Required - The team ID to list devices for ### Request Example ```bash make-cli devices list --team-id=5 ``` ### Response Success response lists the devices registered in the specified team. Specific details not provided. #### Success Response (200) Not specified #### Response Example Not specified ``` -------------------------------- ### Create a Make CLI Credential Request Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/credentials Create a credential request for the authenticated user to set up connections and keys. The response provides a URL for user authorization. ```bash make-cli credential-requests create \ --name='Google Connection Request' \ --team-id=5 \ --credentials='[{"appName":"google","appModules":["*"]}]' ``` -------------------------------- ### Make CLI SDK Connections Create Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/custom-app-development Creates a new connection for a specific application. ```APIDOC ## make-cli sdk-connections create ### Description Create a new connection for a specific app. ### Method CLI Command ### Endpoint N/A (CLI command) ### Parameters #### Query Parameters - **--app-name** (string) - Required - The name of the app - **--type** (string) - Required - The type of the connection - **--label** (string) - Required - The label of the connection visible in the scenario builder ### Request Example ```bash make-cli sdk-connections create \ --app-name=my-app \ --type=oauth2 \ --label='OAuth 2.0' ``` ### Response #### Success Response (200) - **message** (string) - Confirmation message. #### Response Example ```json { "message": "Connection created successfully." } ``` ``` -------------------------------- ### Make CLI Category Help Source: https://developers.make.com/make-cli/make-cli/make-cli-reference To view commands specific to a category, append --help to the category name. ```bash make-cli --help ``` -------------------------------- ### Make CLI SDK Apps Get Common Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/custom-app-development Retrieves common data for a specific application, including client credentials and shared configuration. ```APIDOC ## make-cli sdk-apps get-common ### Description Get app common data (client credentials and shared configuration). ### Method CLI Command ### Endpoint N/A (CLI command) ### Parameters #### Query Parameters - **--name** (string) - Required - The name of the app - **--version** (string) - Required - The version of the app ### Request Example ```bash make-cli sdk-apps get-common --name=my-app --version=1 ``` ### Response #### Success Response (200) - **commonData** (object) - The common data including client credentials and shared configuration. #### Response Example ```json { "commonData": { "clientId": "my-client-id", "clientSecret": "my-client-secret", "sharedConfig": {} } } ``` ``` -------------------------------- ### Get detailed make-cli execution result Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/scenarios Retrieve detailed results for a specific scenario execution using both the scenario ID and the execution ID. ```bash make-cli executions get-detail \ --scenario-id=925 \ --execution-id=a07e16f2ad134bf49cf83a00aa95c0a5 ``` -------------------------------- ### Help Commands Source: https://developers.make.com/make-cli/make-cli/make-cli-reference Access help information for the Make CLI. View all available commands or commands for a specific category. ```APIDOC ## Help Commands To view all available commands and options, run: ```bash make-cli --help ``` To view commands for a specific category, run: ```bash make-cli --help ``` ``` -------------------------------- ### Get credential request details Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/credentials Fetch detailed information for a specific credential request using its ID. This includes all associated credentials and their statuses. ```bash make-cli credential-requests get --request-id=a07e16f2ad134bf49cf83a00aa95c0a5 ``` -------------------------------- ### Get Specific Data Structure Details Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/data-stores Use this command to retrieve the details of a single data structure. Requires the data structure ID. ```bash make-cli data-structures get --data-structure-id=178 ``` -------------------------------- ### List Organizations with Make CLI Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/account-management Lists all organizations associated with the current user. ```bash make-cli organizations list ``` -------------------------------- ### List Available Timezones with make-cli Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/account-management Use this command to retrieve a list of all supported timezones within the make-cli environment. No additional setup is required. ```bash make-cli enums timezones ``` -------------------------------- ### Create a New Make Scenario Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/scenarios Create a new scenario with specified team ID, scheduling, and blueprint. The blueprint defines the scenario's name and flow. Use `--confirmed` if the scenario uses uninstalled apps. ```bash make-cli scenarios create \ --team-id=5 \ --scheduling='{"type":"indefinitely","interval":60}' \ --blueprint='{ "name": "Gmail Attachments to Google Drive", "flow": [ { "id": 1, "module": "google-email:watchEmails", "version": 1, "parameters": { "connection": 5, "folder": "INBOX", "filter": "has:attachment" }, "mapper": {}, "metadata": { "expect": [] } }, { "id": 2, "module": "google-drive:uploadFile", "version": 1, "parameters": { "connection": 6 }, "mapper": { "folderId": "your-folder-id-here", "file": "{{1.attachments[]}}" }, "metadata": { "expect": [] } } ], "metadata": { "version": 1 } }' ``` -------------------------------- ### Create New App Module with Make CLI Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/custom-app-development Create a new module within an app. This command requires essential details such as app name, version, module name, type ID, label, and description. ```bash make-cli sdk-modules create \ --app-name=my-app \ --app-version=1 \ --name=listItems \ --type-id=4 \ --label='List Items' \ --description='Returns a list of items from the API.' ``` -------------------------------- ### Get Single App RPC Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/custom-app-development Retrieves a specific remote procedure (RPC) by its name. You need to provide the app name, version, and the RPC name. ```bash make-cli sdk-rpcs get --app-name=my-app --app-version=1 --rpc-name=getFields ``` -------------------------------- ### List App Modules with Make CLI Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/custom-app-development List all modules associated with a specific app. You can filter the results by providing the app name and version. ```bash make-cli sdk-modules list --app-name=my-app --app-version=1 ``` -------------------------------- ### Get a single function by name Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/custom-app-development Retrieves details for a specific function within an app. Requires app name, app version, and function name. ```bash make-cli sdk-functions get \ --app-name=my-app \ --app-version=1 \ --function-name=parseDate ``` -------------------------------- ### Get a specific section of a connection Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/custom-app-development Use this command to retrieve a specific section's data from a connection. Requires the connection name and the section to retrieve. ```bash make-cli sdk-connections get-section --connection-name=my-app --section=api ``` -------------------------------- ### Create SDK App Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/custom-app-development Creates a new SDK app with specified details. ```APIDOC ## Create SDK App ### Description Create a new SDK app. ### Method POST ### Endpoint /sdk-apps ### Parameters #### Request Body - **name** (string) - Required - The name of the app visible in the URL. - **label** (string) - Required - The label of the app visible in the scenario builder. - **description** (string) - Optional - The description of the app. - **theme** (string) - Required - The color of the app logo (e.g., '#FF5733'). - **language** (string) - Required - The language of the app (e.g., 'en'). - **countries** (array) - Optional - Countries where the app is available (e.g., ['US', 'CA']). - **private** (boolean) - Optional - Whether the app is private. - **audience** (string) - Required - Audience setting for the app (e.g., 'global'). ### Request Example ```bash make-cli sdk-apps create \ --name=my-app \ --label='My App' \ --description='A custom app' \ --theme=#FF5733 \ --language=en \ --audience=global ``` ### Response #### Success Response (201) - **message** (string) - Confirmation message. #### Response Example ```json { "message": "SDK app 'my-app' created successfully." } ``` ``` -------------------------------- ### Get make-cli scenario interface Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/scenarios Retrieve the interface definition for a specific scenario using its ID. This is useful for understanding the expected input and output of a scenario. ```bash make-cli scenarios interface --scenario-id=925 ``` -------------------------------- ### List Regions with Make CLI Source: https://developers.make.com/make-cli/make-cli/make-cli-reference/account-management Lists all available regions for use in Make CLI operations. ```bash make-cli enums regions ```