Using the Workflows API

Prerequisites

Before you can use Workflows API, ensure the following requirements are met:

Your role must include write permissions for both network-level and organization-level settings. For more information, see Role-Based Access Control in Meraki documentation.

Workflows APIs require full organization access on every organization you want to manage.

You must have a valid API key generated from your Meraki Dashboard. For detailed steps, refer to the Generate an API Key section in the Meraki documentation.

Each user can have up to 2 API keys.
Keys are tied to your email address, not to a specific organization.
If your account has access to multiple organizations, the same key works across all of them within your permissions.
The API key does not need to be generated for every request. Once created, it can be used repeatedly until revoked.

Obtain the unique ID of the organization you want to manage, which can be found in your Meraki Dashboard footer.

Workflows API Access

Using the Workflows API Within Cisco Workflows

Access the Workflows API from within Cisco Workflows by creating an HTTP Endpoint target secured with Bearer Authentication.

Step 1: Create an HTTP Endpoint Target

Navigate to Automation > Targets.
Click Add New Target and select HTTP Endpoint.
Enter the base URL for the Workflows API (e.g., https://api.meraki.com).
Under Default Account Keys, create a new Account Key with type HTTP Bearer Authentication.
Enter your Meraki API key as the bearer token. Your API key is securely stored and encrypted.
Save the target.

Target Type Meraki API.png Account Key Meraki API.png

Step 2: Create Your Workflow

Navigate to Automation > Workspace.
On the Workflows tab, click Create Workflow or edit an existing workflow.
Drag and drop a Generic HTTP Request activity onto the workflow canvas.
In the Properties panel, specify:
- API endpoint URL (e.g., /api/automate/organizations/<ORG_ID>/v1.1/workflows?limit=100)
- API method (e.g., GET, POST)
Select the HTTP Endpoint target you created in Step 1.

Workflow Target Meraki API.png

Once your HTTP Endpoint target is set up, you can reuse it across any number of workflows to make any Workflows API request you need.

Using REST API Call

Include the API key in the request header for authentication. Here is an example curl command:

curl -X POST 'https://api.meraki.com/api/automate/organizations/<ORG_ID>/v1.1/workflows?limit=100' \
  --header 'Authorization: Bearer <API_KEY>'

Component	Description
API Key	Authorization header with your API key, in `Bearer` format
Base URL	`For example:` `https://api.meraki.com/api/automate/organizations`
Organization	Replace `<ORG_ID>` with your organization's unique ID (found in the Dashboard Footer)
API Version	Example `v1`, `v1.1`, `v2` — replace with the version of the endpoint you want to access
Endpoint	`/workflows` — resource you are accessing

Download the Automation OpenAPI Specification

Download the Automation OpenAPI specification (OAS) file file and open it in your preferred text editor.

If you want to view the OAS document in Swagger UI using Docker, run the following command in the directory containing the oas.json file:

docker run -p 8080:8080 -e SWAGGER_JSON=/app/oas.json -v $(pwd)/oas.json:/app/oas.json swaggerapi/swagger-ui

After running the command, open your browser and go to http://localhost:8080 to view the API structure.

You can use Swagger UI in Docker to view the structure and endpoints of the OAS file, but you won’t be able to make live API calls from the UI because of CORS limitations.