Embedded API

Resources

API platform

TypeResourceDescription
GET/api/managed_users
/:managed_user_id/
api_collections		List API collections
POST/api/managed_users
/:managed_user_id/
api_collections		Create an API collection
GET/api/managed_users
/:managed_user_id/
api_endpoints		List API endpoints
PUT/api/managed_users
/:managed_user_id/
api_endpoints
/:api_endpoint_id/disable		Disable an API endpoint
PUT/api/managed_users
/:managed_user_id/
api_endpoints
/:api_endpoint_id/enable		Enable an API endpoint
GET/api/managed_users
/:managed_user_id/
api_clients		List API clients
GET/api/v2/managed_users
/:managed_user_id/
api_clients		List API clients
POST/api/managed_users
/:managed_user_id/
api_clients		Create an API client
POST/api/v2/managed_users
/:managed_user_id/
api_clients		Create an API client
GET/api/v2/managed_users
/:managed_user_id/
api_clients/:api_client_id		Retrieve details of an API client in a customer workspace using its ID.
PUT/api/v2/managed_users
/:managed_user_id/
api_clients/:api_client_id		Update an existing API client within a project you specify in a customer workspace.
GET/api/managed_users
/:managed_user_id/
api_access_profiles		List access profiles belonging to an API client
POST/api/managed_users
/:managed_user_id/
api_access_profiles		Create an access profile belonging to an API client
PUT/api/managed_users
/:managed_user_id
/api_access_profiles
/:api_access_profile_id		Update an access profile belonging to an API client
PUT/api/managed_users
/:managed_user_id/
api_access_profiles
/:api_access_profile_id/disable		Disable an access profile
PUT/api/managed_users
/:managed_user_id/
api_access_profiles
/:api_access_profile_id/enable		Enable an access profile
PUT/api/managed_users
/:managed_user_id/
api_access_profiles
/:api_access_profile_id
/refresh_secret		Refresh token secret or OAuth client secret
GET/api/v2/managed_users
/:id/api_clients
/:api_client_id
/api_keys		Retrieves all API keys for an API client.
POST/api/v2/managed_users
/:id/api_clients
/:api_client_id/api_keys		Creates a new API key for an API client.
PUT/api/v2/managed_users
/:id/api_clients
/:api_client_id/api_keys
/:api_key_id		Updates an existing API key for an API client.
PUT/api/v2/managed_users
/:id/api_clients/
:api_client_id/api_keys
/:api_key_id/enable		Enables an API key for an API client, allowing it to make authenticated requests.
PUT/api/v2/managed_users
/:id/api_clients/
:api_client_id/api_keys
/:api_key_id/disable		Disables an API key for an API client, preventing it from making API requests.
PUT/api/v2/managed_users
/:id/api_clients/
:api_client_id
/api_keys/:api_key_id/refresh_secret		Refreshes the authentication token or OAuth 2.0 client secret for an API key.
GET/api/v2/managed_users
/:id/api_portals		Retrieves a list of all API portals associated with API clients in your workspace.
GET/api/managed_users
/:id/cert_bundles		List all certificate bundles.
POST/api/managed_users
/:id/cert_bundles		Create a new certificate bundle.
PUT/api/managed_users
/:id/cert_bundles/
:certificate_bundle_id		Update a certificate bundle.
DELETE/api/managed_users
/:id/cert_bundles/
:certificate_bundle_id		Delete a certificate bundle.
GET/api/managed_users
/:id/cert_bundles/
:certificate_bundle_id/download		Download the certificate bundle PEM file.

Connections

TypeResourceDescription
GET/api/managed_users/
:managed_user_id
/connections		Returns a list of connections in Embedded user’s account.
POST/api/managed_users/
:managed_user_id
/connections		Allows the Embedded partner to add a shell connection in a customer’s account.
DELETE/api/managed_users/
:managed_user_id
/connections/:connection_id		Deletes a connection in a customer workspace.
PUT/api/managed_users/
:managed_user_id
/connections/:connection_id		Updates a connection in a customer workspace.
POST/api/managed_users/
:managed_user_id
/connections/:connection_id/disconnect		Disconnects a connection in a customer workspace.

Connectors

TypeResourceDescription
GET/api/integrationsReturns a list of connectors and metadata specified in request.
GET/api/integrations/allReturns a paginated list of all connectors and associated metadata in an Embedded partner’s account. The response includes standard and platform connectors.

Custom connectors

TypeResourceDescription
GET/api/custom_connectorsGet custom connectors.
GET/api/custom_connectors/:idGet custom connector by ID.
POST/api/custom_connectors/:id
/oem_share/:version		Create or update a shared connector.
POST/api/managed_users
/:managed_user_id
/recipes/:recipe_id/share		Share/publish a recipe containing a custom connector.
DELETE/api/custom_connectors
/:id/suppress_oem_version		Remove a shared connector.

Custom OAuth profiles

Customer managers

TypeResourceDescription
GET/api/customer_managersList customer managers
POST/api/customer_managersCreate a customer manager
DELETE/api/customer_managers/:idDelete a customer manager
PUT/api/customer_managers/:idUpdate a customer manager

Data retention

TypeResourceDescription
PUT/api/managed_users
/:managed_user_id
/update_data_retention		Update customer workspace’s data retention period.

Data tables

TypeResourceDescription
GET/api/v2/managed_users
/:managed_user_id/data_tables		List all data tables.
GET/api/v2/managed_users
/:managed_user_id
/data_tables/:data_table_id		Get data table by ID.
POST/api/v2/managed_users
/:managed_user_id/data_tables		Creates a data table.
PUT/api/v2/managed_users
/:managed_user_id/data_tables
/:data_table_id		Updates a data table you specify.
DELETE/api/v2/managed_users
/:managed_user_id
/data_tables
/:data_table_id		Deletes a data table you specify.
POST/api/v2/managed_users
/:managed_user_id/data_tables
/:data_table_id/truncate		Truncates a data table you specify. Truncating a data table deletes all data from a data table, but leaves the table structure intact.

Dynamic field mapping

TypeResourceDescription
GET/api/v2/managed_users
/:managed_user_id
/recipes/:recipe_id
/field_map_introspections		List all field map introspections in a specific recipe.
GET/api/v2/managed_users
/:managed_user_id
/recipes/:recipe_id
/field_map_introspections
/:id		List the field map introspections for a specific field map schema.
PUT/api/v2/managed_users
/:managed_user_id
/recipes/:recipe_id
/field_map_introspections
/:id		Update field mapping for a specific field map schema.
POST/api/v2/managed_users
/:managed_user_id
/recipes/:recipe_id
/field_map_introspections/:id
/refresh_schema		Refresh a recipe’s schema to update field map introspections.
POST/api/v2/managed_users
/:managed_user_id
/recipes/:recipe_id
/field_map_introspections
/:id/pick_list		Retrieve picklist values for specific fields within a field map introspection of a recipe.

Environment management

TypeResourceDescription
GET/api/managed_users/:id/activity_logsGet activity audit log records in a customer workspace.
GET/api/v2/managed_users/:id/tagsRetrieve a list of tags in a customer workspace.
POST/api/v2/managed_users/:id/tagsCreate a tag in a customer workspace.
PUT/api/v2/managed_users/:id/tags/:handleUpdate a tag in a customer workspace.
DELETE/api/v2/managed_users/:id/tags/:handleDelete a tag in a customer workspace.

Environment properties

TypeResourceDescription
GET/api/managed_users
/:managed_user_id/properties		List properties by prefix
POST/api/managed_users
/:managed_user_id/properties		Upserts properties

Folders

TypeResourceDescription
GET/api/managed_users
/:managed_user_id/folders		List folders in a customer workspace.
POST/api/managed_users
/:managed_user_id/folders		Create a folder in a customer workspace.
PUT/api/managed_users
/:managed_user_id
/folders/:folder_id		Update a folder in a customer workspace.
DELETE/api/managed_users
/:managed_user_id
/folders
/:folder_id		Delete a folder in a customer workspace.

Jobs

TypeResourceDescription
PUT/api/account/signature_verification_keyUpdate JWT signature verification key

Lookup tables

TypeResourceDescription
GET/api/managed_users/
:managed_user_id
/lookup_tables		List lookup tables
POST/api/managed_users/
:managed_user_id
/lookup_tables		Create a new lookup table
POST/api/managed_users
/:managed_user_id/
lookup_tables/batch_delete		Delete lookup tables in batch
GET/api/managed_users
/:managed_user_id/
lookup_tables/:lookup_table_id/lookup		Lookup a row
GET/api/managed_users
/:managed_user_id/
lookup_tables/:lookup_table_id/rows		List rows
POST/api/managed_users
/:managed_user_id/
lookup_tables/:lookup_table_id/rows		Add a row
DELETE/api/managed_users
/:managed_user_id/
lookup_tables/:lookup_table_id
/rows/:row_id		Delete a row
GET/api/managed_users
/:managed_user_id/
lookup_tables/:lookup_table_id
/rows/:row_id		Get a row
PUT/api/managed_users
/:managed_user_id/
lookup_tables/:lookup_table_id
/rows/:row_id		Update a row

Manage customers

TypeResourceDescription
GET/api/managed_usersGet list of customer accounts.
POST/api/managed_usersCreate customer account.
GET/api/managed_users/usageGet monthly usage.
DELETE/api/managed_users
/:managed_user_id		Deprecated. Delete customer account.
GET/api/managed_users
/:managed_user_id		Get customer account.
PUT/api/managed_users
/:managed_user_id		Update customer account.
GET/api/managed_users
/:managed_user_id/members		Get list of customer account members.
POST/api/managed_users
/:managed_user_id/members		Add member to customer account.
DELETE/api/managed_users
/:managed_user_id/members
/:member_id		Remove member from customer account.
GET/api/managed_users
/:managed_user_id/members
/:member_id		Get customer account member.
PUT/api/managed_users
/:managed_user_id/members
/:member_id		Deprecated. Update customer account member.
POST/api/managed_users
/:managed_user_id
/environments		Provision Environments for an existing customer.
POST/api/v2/managed_users
/statistics/usage		Retrieves usage metrics for specified customer workspaces within a defined time frame, including task usage, recipe counts, and counts of successful and failed jobs.
POST/api/v2/managed_users
/statistics/
connection_usage		Retrieve connection-based usage metrics for specified customer workspaces.
POST/api/v2/managed_users
/statistics/usage		Retrieves usage metrics for specified customer workspaces within a defined time frame, including task usage, recipe counts, and counts of successful and failed jobs.

On-prem

TypeResourceDescription
GET/api/v2/managed_users
/:id/on_prem_groups		List On-prem Groups in a customer workspace.
POST/api/v2/managed_users
/:id/on_prem_groups		Create an On-prem Group in a customer workspace.
GET/api/v2/managed_users
/:id/on_prem_groups
/:group_id		Retrieve details about an On-prem Group in a customer workspace.
PUT/api/v2/managed_users
/:id/on_prem_groups
/:group_id		Updates an On-prem group in a customer workspace.
DELETE/api/v2/managed_users
/:id/on_prem_groups
/:group_id		Deletes an On-prem group in a customer workspace.
GET/api/v2/managed_users
/:id/on_prem_groups
/:group_id
/status		Retrieves status of an On-prem group in a customer workspace.
GET/api/v2/managed_users
/:id/
on_prem_agents		List On-prem Agents in a customer workspace.
POST/api/v2/managed_users
/:id/
on_prem_agents		Create an On-prem Agent in a customer workspace.
GET/api/v2/managed_users
/:id/on_prem_agents
/:agent_id		Retrieve the details of a specific On-prem Agent in a customer workspace using its ID.
PUT/api/v2/managed_users
/:id/on_prem_agents
/:agent_id		Update an On-prem Agent in a customer workspace.
DELETE/api/v2/managed_users
/:id/on_prem_agents
/:agent_id		Delete an On-prem Agent in a customer workspace.
GET/api/v2/managed_users
/:id/on_prem_agents
/:agent_id
/status		Retrieve the status of an On-prem Agent in a customer workspace.
GET/api/v2/managed_users
/:id/on_prem_agents
/search		Finds On-prem Agents in a customer workspace by common name.

Picklists

TypeResourceDescription
POST/api/managed_users/:managed_user_id/
connections/:connection_id/pick_list		Obtain a list of picklist values for a specified connection in an Embedded customer account.

Projects

TypeResourceDescription
GET/api/managed_users/
:managed_user_id
/projects		List projects in a customer workspace.
POST/api/managed_users/
:managed_user_id/folders		Create a project in a customer workspace.
PUT/api/managed_users
/:managed_user_id/
projects/:project_id		Update a project in a customer workspace.
DELETE/api/managed_users
/:managed_user_id/
projects/:project_id		Delete a project in a customer workspace.
GET/api/managed_users/
:managed_user_id
/deployments		Retrieve a list of deployments in a customer workspace.
GET/api/managed_users/:managed_user_id/
deployments/:id		Retrieve a single deployment in a customer workspace.
GET/api/managed_users/:managed_user_id/
api/project_builds/:id		Retrieve a downloaded package in a customer workspace.
POST/api/managed_users
/:managed_user_id
/projects/:id/build		Build a project in a customer workspace.
POST/api/managed_users
/:managed_user_id
/project_builds/:id/deploy		Deploy a downloaded package in a customer workspace.
POST/api/managed_users
/:managed_user_id/
projects/:project_id/deploy		Deploy a project in a customer workspace.
GET/api/managed_users
/:managed_user_id/
deployments/:id/eligible_reviewers		Retrieve a list of eligible reviewers that can be assigned to review a deployment in a customer workspace.
POST/api/managed_users
/:managed_user_id/
deployments
/:id/assign_reviewers		Assign reviewers to a deployment in a customer workspace.
POST/api/managed_users
/:managed_user_id/
deployments/:id/submit_for_review		Submit a deployment for review in a customer workspace.
POST/api/managed_users/:managed_user_id/
deployments
/:id/deploy		Deploy an approved deployment in a customer workspace.

Recipes

TypeResourceDescription
GET/api/managed_users
/:managed_user_id
/recipes		List recipes belonging to a customer.
POST/api/managed_users
/:managed_user_id/recipes		Create a recipe in a customer workspace.
DELETE/api/managed_users
/:managed_user_id/
recipes
/:recipe_id		Delete a recipe in a customer workspace.
GET/api/managed_users
/:managed_user_id/
recipes/:recipe_id		Get details of a recipe belonging to a customer.
PUT/api/managed_users
/:managed_user_id/
recipes
/:recipe_id		Update a recipe in a customer workspace.
POST/api/managed_users
/:managed_user_id/
recipes
/:recipe_id/copy		Copy a recipe in a customer workspace.
POST/api/managed_users
/:managed_user_id/
recipes
/:recipe_id/poll_now		Forces a running recipe to poll immediately
POST/api/managed_users
/:managed_user_id/
recipes/:recipe_id
/reset_trigger		Reset recipe trigger.
PUT/api/managed_users
/:managed_user_id/
recipes
/:recipe_id/start		Start a recipe in a customer workspace.
PUT/api/managed_users
/:managed_user_id/
recipes
/:recipe_id/stop		Stop a recipe in a customer workspace.
GET/api/recipes/searchSearch for public recipes. Requires oem_vendor privilege.
GET/api/v2/managed_users
/:managed_user_id/recipes
/:recipe_id
/versions		Get versions of a recipe belonging to a customer.
GET/api/managed_users
/:managed_user_id/recipes
/:recipe_id/versions		Get versions of a recipe belonging to a customer.
PUT/api/v2/managed_users
/:managed_user_id/recipes/
:recipe_id/versions/:id		Update a recipe version comment in a customer workspace.

Recipe lifecycle management

Roles

TypeResourceDescription
GET/api/managed_users
/:managed_user_id
/roles		List custom roles belonging to user
POST/api/managed_users
/:managed_user_id/roles
/:id/copy		Copy a custom role

Tags assignments

TypeResourceDescription
POST/api/v2/managed_users
/:id/tags_assignments		Apply or remove asset tags in a customer workspace.

Test automation

TypeResourceDescription
POST/api/managed_users
/:managed_user_id/
test_cases/run_requests		Run test cases in a customer workspace.
GET/api/managed_users
/:managed_user_id/
recipes/:recipe_id/test_cases		Get test cases for a specific recipe in a customer workspace.
GET/api/managed_users
/:managed_user_id/
test_cases/run_requests
/:test_id		Get the current state of a test case run request in a customer workspace.