v4

latestOpenAPI 3.0.1Apache 2.02026-07-312457525.9 MB

Workspace API

Get the ID of an object using its human-readable identifier

get/workspaces/{workspace_domain}/identifiers

Path parameters

workspace_domainstring required

Example:my-company

The human-readable ID of the workspace

Query parameters

projectstring

Example:my-project

The human-readable ID of the project

pipelinestring

Example:my-pipeline

The human-readable ID of the pipeline

environmentstring

Example:my-environment

The human-readable ID of the environment

artifactstring

Example:my-artifact

The human-readable ID of the artifact

artifact_versionstring

Example:v1

The version of the artifact

sandboxstring

Example:my-sandbox

The human-readable ID of the sandbox

unit_test_suitestring

Example:my-unit-test-suite

The human-readable ID of the unit test suite

visual_test_suitestring

Example:my-visual-test-suite

The human-readable ID of the visual test suite

crawl_suitestring

Example:my-crawl-suite

The human-readable ID of the crawl suite

distributionstring

Example:my-distribution

The human-readable ID of the distribution

route_subdomainstring

Example:api

The subdomain of the route. Resolved together with route_domain and route_path against the parent distribution.

route_domainstring

Example:example.com

The domain of the route. Required to resolve a route.

route_pathstring

Example:v1

The path of the route. Resolved together with route_subdomain and route_domain against the parent distribution.

agentstring

Example:my-agent

The human-readable ID of the tunnel agent

tunnelstring

Example:my-tunnel

The name of the tunnel. Requires agent to be resolved.

Response

urlstring

API endpoint to GET this object

html_urlstring

Web URL to view this object in Buddy.works

domainstring

The human-readable ID of the workspace

project_identifierstring

The human-readable ID of the project

pipeline_idinteger

The ID of the pipeline

environment_idstring

The ID of the environment

artifact_idstring

The ID of the artifact

artifact_version_idstring

The ID of the artifact version

sandbox_idstring

The ID of the sandbox

unit_test_suite_idstring

The ID of the unit test suite

visual_test_suite_idstring

The ID of the visual test suite

crawl_suite_idstring

The ID of the crawl suite

distribution_idstring

The ID of the distribution

route_idstring

The ID of the route

agent_idstring

The ID of the tunnel agent

tunnel_idstring

The ID of the tunnel