Skip to main content

mabl resource IDs

Molly Exten
  • Updated

Every component in a workspace, from applications and environments to ad-hoc test runs, has a unique ID known as a mabl resource ID. mabl resource IDs are required for many commands in the mabl CLI and for parameter values in mabl API endpoints.

The article describes how to obtain different types of mabl resource IDs from the mabl app, CLI, and API:

Workspace

Workspace IDs end in -w.

To obtain workspace IDs:

  • mabl CLI: run the mabl workspaces list command.
  • mabl app: go to Settings > Workspace and copy the ID.
Accessing the workspace ID in the app

Users

Unlike other mabl resource IDs, user IDs do not have a suffix.

To obtain user IDs:

  • mabl CLI: run the mabl users list command.
  • mabl API: send a request to the query users endpoint.

Applications

Application IDs end in -a.

To obtain application IDs:

  • mabl CLI: run the mabl applications list command.
  • mabl API: send a request to the query applications endpoint.
  • mabl app: go to Settings > APIs, and scroll down to the mabl CLI section, and select an application from the dropdown. The application ID appears in the sample mabl CLI command.
Accessing the application ID in the app

Environments

Environment IDs end in -e.

To obtain environment IDs:

  • mabl CLI: run the mabl environments list command.
  • mabl API: send a request to the query environments endpoint.
  • mabl app: go to Settings > APIs, and scroll down to the mabl CLI section, and select an environment from the dropdown. The environment ID appears in the sample mabl CLI command.
env-id-app.png

Deployment events

Deployment event IDs end in -v.

To obtain deployment event IDs:

  • mabl CLI: run the mabl deployments list command.
  • mabl API: extract the deployment ID from the response of a created deployment event.
  • mabl app: go to Results > By deployment and click on the Event time for a specific deployment event. The deployment event ID appears in the top right corner of the details view.
Accessing the deployment event ID in the app

Plans

Plan IDs end in -p.

To obtain plan IDs:

  • mabl CLI: run the mabl plans list command.
  • mabl app: click on the CLI icon on the plan details page.
Accessing plan IDs in the app

Plan runs

Plan run IDs end in -pr.

To obtain plan run IDs:

  • mabl API: extract plan run IDs from the response of reporting API endpoints or the deployment results endpoint.
  • mabl app: click on the Download CSV button the plan details page. The CSV file includes plan run IDs for each plan run.
Accessing plan run IDs in the app

Tests

Test IDs end in -j.

To obtain test IDs:

  • mabl CLI: run the mabl tests list command.
  • mabl app: click on the CLI icon on the test details page.
test-id-app.png

Test runs

Test run IDs end in -jr.

To obtain test run IDs:

test-run-id-app.png

Credentials

Credential IDs end in -c.

To obtain credential IDs:

  • mabl CLI: run the mabl credentials list command.
  • mabl API: send a request to the query credentials endpoint.
  • mabl app: click on the CLI icon on the credential details page.
cred-id-app.png

Link Agents

Link Agent IDs end in -la.

To obtain Link Agent IDs:

  • mabl CLI: run the mabl link-agents list command.
  • mabl API: send a request to the query link agents endpoint.

Database connections

Database connection IDs end in -dc.
To obtain database connection IDs:

  • mabl CLI: run the mabl databases list command.

Flows

Flow IDs end in -f.

To obtain flow IDs:

  • mabl CLI: run the mabl flows list command.

DataTables

DataTable IDs end in -vt.

To obtain DataTable IDs:

  • mabl CLI: run the mabl datatables list command.
  • mabl API: send a request to the query datatables endpoint.
  • mabl app: click on the CLI icon on the edit DataTable page.
Accessing DataTable IDs in the app

DataTable scenarios

DataTable scenario IDs end in -vr

To obtain DataTable scenario IDs:

  • mabl CLI: run the mabl datatables scenarios {datatable_id} command.
  • mabl API: send a request to the query scenarios endpoint.

Related articles