# Workato API Resources
# Projects
Type | Resource | Description |
---|---|---|
POST | /api/projects/:id/build | Builds a project. Use the Deploy a project build endpoint to deploy the project to an environment. |
GET | /api/project_builds/:id | Retrieves a project build by its unique ID. |
POST | /api/project_builds/:id/deploy?environment_type=:environment_type | Deploys a project build to an environment. Use the Build a project endpoint to build the project first. |
POST | /api/projects/:id/deploy?environment_type=:environment_type | Builds and deploys a project to an environment. |
GET | /api/deployments/:id | Retrieves a single deployment by its unique ID. |
GET | /api/deployments | Retrieves a list of deployments. Query parameters may be used to filter results to a specific project, folder, date range, etc. |
# Connections
Type | Resource | Description |
---|---|---|
GET | /api/connections | List connections belonging to user. |
# Custom connectors
Type | Resource | Description |
---|---|---|
GET | /api/custom_connectors | Get custom connectors. |
POST | /api/sdk/generate_schema/json | Generates Workato schema from a stringified JSON sample. |
POST | /api/sdk/generate_schema/csv | Generates Workato schema from a stringified CSV sample. |
# Jobs
Type | Resource | Description |
---|---|---|
GET | /api/recipes/:recipe_id/jobs | List jobs belonging to recipe. |
GET | /api/recipes/:recipe_id/jobs/:job_handle | Returns a single job's metadata. |
# Recipes
Type | Resource | Description |
---|---|---|
GET | /api/recipes/:id | Get recipe details. |
POST | /api/recipes | Create recipe. |
POST | /api/recipes | Copy recipe. |
PUT | /api/recipes/:id | Update recipe. |
GET | /api/recipes | List recipes belonging to user. |
PUT | /api/recipes/:id/start | Start recipe. |
PUT | /api/recipes/:id/stop | Stop recipe. |
DELETE | /api/recipes/:id | Delete recipe. |
# User
Type | Resource | Description |
---|---|---|
GET | /api/users/me | Get details of authenticated user. |
# Recipe Lifecycle Management
Type | Resource | Description |
---|---|---|
POST | api/export_manifests | Create an export manifest. |
PUT | api/export_manifests/:id | Update an export manifest. |
GET | api/export_manifests/:id | View an export manifest. |
POST | /api/packages/export/:manifest_id | Export package based on a manifest. |
POST | /api/packages/import/:folder_id | Import package into a folder. |
GET | /api/packages/:id | Get package by ID. |
GET | /api/packages/:id/download | Download package. |
# API Platform
Type | Resource | Description |
---|---|---|
GET | /api/api_collections | List API collections. |
POST | /api/api_collections | Create API collection. |
GET | /api/api_endpoints | List API endpoints in a collection. |
PUT | /api/api_endpoints/:id/enable | Enable an API endpoint in a collection. |
PUT | /api/api_endpoints/:id/disable | Disable an API endpoint in a collection. |
GET | /api/api_clients | List API clients. |
POST | /api/api_clients | Create API client. |
GET | /api/api_access_profiles | List access profiles belonging to an API client. |
POST | /api/api_access_profiles | Create an access profile belonging to an API client. |
PUT | /api/api_access_profiles | Update an access profile belonging to an API client. |
PUT | /api_access_profiles | Enable an access profile belonging to an API client. |
PUT | /api_access_profiles | Disable an access profile belonging to an API client. |
PUT | /api/api_access_profiles/:id/refresh_secret | Refreshes access profile token or secret. |
# Roles
Type | Resource | Description |
---|---|---|
GET | /api/roles | List custom roles. |
POST | /api/roles/:role_id/copy | Makes a copy of a custom role. |
# Environment Properties
Type | Resource | Description |
---|---|---|
GET | /api/properties | Lists environment properties that matches a prefix. |
POST | /api/properties | Upserts environment properties. |
# Lookup tables
Type | Resource | Description |
---|---|---|
GET | /api/lookup_tables | List tables. |
GET | /api/lookup_tables/:lookup_table_id/lookup | Look up a row |
GET | /api/lookup_tables/:lookup_table_id/rows | List rows. |
GET | /api/lookup_tables/:lookup_table_id/rows/:row_id | Get a row. |
POST | /api/lookup_tables/:lookup_table_id/rows | Add a row. |
POST | /api/lookup_tables | Create a new lookup table. |
POST | /api/lookup_tables/batch_delete | Delete lookup tables in batch. |
PUT | /api/lookup_tables/:lookup_table_id/rows/:row_id | Update a row. |
DELETE | /api/lookup_tables/:lookup_table_id/rows/:row_id | Delete a row. |
# Project properties
Type | Resource | Description |
---|---|---|
GET | /api/properties | List project-level properties that match a prefix and project ID. |
POST | /api/properties | Upsert project-level properties. |
# PubSub
Type | Resource | Description |
---|---|---|
POST | /api/pubsub/topics/:topic_id/consume | Consume messages from a topic. |
POST | /api/pubsub/topics/:topic_id/publish | Publish a message to a topic. |
# Secrets management
Type | Resource | Description |
---|---|---|
POST | /api/secrets_management/clear_cache | Clears the secrets management cache. |
# Test Automation
Type | Resource | Description |
---|---|---|
POST | /api/test_cases/run_requests | Run test cases. |
GET | /api/test_cases/run_requests/{id} | Get the current state of a test case run request. |
GET | /api/recipes/{recipe_id}/test_cases | Get test cases. |
Last updated: 9/18/2023, 4:54:13 PM