/
BU
buddy
/
Buddy API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Checked 9h ago · Updated 4d ago
Details
Filter operations
Action API
5
get
Returns list of actions in the specified pipeline
post
Creates a new action in the pipeline
get
Returns details of a single action
delete
Delete an action from the pipeline
patch
Update action configuration
Artifact API
5
get
Get artifacts list
post
Create a new artifact
get
Get a specific artifact by ID
delete
Delete a artifact
patch
Update artifact configuration
Artifact Versions API
13
get
Get artifact versions list
post
Create a new artifact version
get
Get a specific artifact version
delete
Delete a artifact version
get
Get artifact version root content
get
Get artifact version content at specific path
post
Create new directory in artifact version
delete
Delete a file or directory
get
Download file content
post
Upload file to artifact version
get
Download artifact version as ZIP
post
Upload artifact version from ZIP archive
post
Create version and and upload content
Crawl API
8
get
Get all crawl suites for a project
post
Add a new crawl suite to a project
get
Get a crawl suite
delete
Delete a crawl suite
patch
Update a crawl suite
get
Get crawl sessions for a suite
get
Get a crawl session
get
Get crawl suite token
Distribution API
6
get
Get all distributions in the workspace
post
Create a new distribution
get
Get a specific distribution by ID
delete
Delete a distribution
patch
Update distribution configuration
get
Get domains routable to a distribution
Domains API
12
get
Get all domains in the workspace
get
Get a specific domain by name
get
Get all records for domain
get
Get all records for domain or subdomain
get
Get one record by type
delete
Delete record
patch
Create or update record
post
Claim an existing domain
get
Check claimable domains availability for a subdomain name
post
Register a new domain
post
Search domains availability
get
Search a single domain availability and price
Environment API
5
get
Get all environments in specified scope
post
Create a new environment
get
Get a specific environment by ID
delete
Delete an environment
patch
Update environment configuration
Group API
10
get
Returns all groups in the workspace
post
Creates a new group. Restricted to admins only
get
Shows details of an user group
delete
Deletes a group
patch
Edits the properties of an existing group
get
Returns all members from the group
post
Adds a user to the group
get
Returns a single member of a user group
delete
Deletes a member from a group
patch
Updates the group member's status
OAuth 2.0
6
post
Register a new OAuth 2.0 client
get
Read client configuration
delete
Delete client
patch
Update client configuration
post
Revoke OAuth 2.0 token
post
Issue OAuth 2.0 token
OIDC API
1
post
Issue a short-lived API token using OIDC provider authentication
Permission API
5
get
Get details of custom permission sets in a workspace
post
Creates a custom permission set. Restricted to admins only.
get
Get details of single custom permission set
delete
Deletes a custom permission set. Restricted to admins only.
patch
Edits a custom permission set. Restricted to admins only.
Project API
53
get
Get all projects in the workspace
post
Create a new project
get
Get a specific project by name
delete
Delete a project
patch
Update project configuration
get
Lists all groups assigned to the specified project. The authorized user must have admin rights in the project to get the information about permissions in that project
post
Assign a group to the project
get
Returns a single user group in the specified project
delete
Remove a group from the project
patch
Update project group permissions
get
Get all members in the project
post
Add a new member to the project
get
Get a specific project member by ID
delete
Remove a member from the project
patch
Update project member permissions
get
Returns all pipelines from the specified project. Pipelines hidden using visibility settings are not included
post
Creates a new pipeline in the project
get
Returns details of a single pipeline
delete
Delete a pipeline
patch
Update pipeline configuration
get
Returns list of executions for the specified pipeline
post
Triggers a new execution of the pipeline
get
Returns details of a single execution
patch
Cancel, retry, or perform other operations on an execution
get
Returns details of a single action execution
get
Returns paginated console output logs of a single action execution
get
Downloads a file that was uploaded for the given execution
post
Adds a new file to the pipeline filesystem and marks it as a static file
put
Updates a file in the pipeline filesystem and marks it as a static file
delete
Deletes a file from the pipeline filesystem
get
Returns details and content of a file from the pipeline filesystem
get
Searches files in the pipeline filesystem by path and content filters
post
Uploads one or more files to temporary storage and returns their identifiers; the file name of each part may be a relative path (for example 'conf/config.json') and is returned unchanged, so files with the same name in different directories stay distinguishable; pass the identifiers together with target paths in the run request to place the files in the pipeline filesystem before execution
get
Returns pipeline configuration in YAML format
patch
Update pipeline configuration using YAML definition
get
Returns list of branches in the repository
post
Creates a new branch in the repository
get
Returns details of a single branch
delete
Deletes a branch from the repository
get
Returns list of commits from the repository
get
Returns details of a single commit
get
Returns the changes between two points. The response from the API is equivalent to running the git log base...head command
get
Returns the contents of the repository for the specified revision or HEAD
post
Creates a new file in the repository
get
Returns the contents of the repository for the specified revision or HEAD
put
Updates an existing file in the repository
delete
Deletes a file from the repository
get
Returns list of pull requests in the repository
get
Returns details of a single pull request
get
Returns list of tags in the repository
post
Creates a new tag in the repository
get
Returns details of a single tag
delete
Deletes a tag from the repository
Route API
7
get
Get all routes in the distribution
post
Create a new route
get
Get a specific route by ID
put
Update route configuration
delete
Delete a route
patch
Update route configuration. Deprecated, use PUT instead.
post
Invalidate CDN cache for a route
Sandbox API
30
get
Get all sandboxes in the workspace for a specific project
post
Create a new sandbox
get
Get a specific sandbox by ID
delete
Delete a sandbox
patch
Update sandbox configuration
get
Get logs from a specific sandbox app
post
Start a sandbox app
post
Stop a sandbox app
get
Get all commands executed in a sandbox
post
Execute a command in a sandbox
get
Get a specific command execution details
get
Get logs from a specific command execution
post
Terminate a running command in a sandbox
get
Get sandbox content by path
post
Create a directory in a sandbox
delete
Delete a file or directory from a sandbox
post
Upload a file to a sandbox
get
Download sandbox content as archive
post
Restart a sandbox
get
Get all snapshots for a sandbox
post
Create a new snapshot of a sandbox
get
Get a specific snapshot by ID
delete
Delete a sandbox snapshot
post
Start a sandbox
post
Stop a sandbox
get
Get sandbox configuration as YAML
patch
Update sandbox configuration using YAML
get
Get all snapshots in the workspace, optionally filtered by project or environment
delete
Delete a snapshot by ID
post
Create a new sandbox from YAML configuration
Target API
13
get
Get all deployment targets in the workspace
post
Create a new deployment target
get
Get a specific target by ID
delete
Delete a deployment target
patch
Update target configuration
get
List recent executions for the target (most recent first).
post
Execute a command against the target. The command kind is determined by the target type; currently supports MySQL targets only (`command` carries the SQL).
get
Get target YAML
patch
Update target from YAML
get
Get the status of a single execution.
delete
Cancel a running execution. No-op on terminal-state executions.
get
Get a slice of the execution log.
post
Add target from YAML
Tunnel API
2
get
Get or create tunnel token
post
Regenerate tunnel token
Unit Test API
24
post
Import test session from JUnit XML file(s) using suite token authentication
post
Add a new test session using suite token authentication
put
Add or update a test case using suite token authentication
post
Add multiple test cases in batch using suite token authentication
post
Close a test session using suite token authentication
post
Reopen a closed test session using suite token authentication
get
Get all unit test suites for a project
post
Add a new unit test suite to a project
get
Get a specific unit test suite
delete
Delete a unit test suite
get
Get all test sessions for a suite
post
Add a new test session to a suite
get
Get a specific test session
delete
Delete a test session
get
Get all test cases for a session
put
Add or update a test case
post
Close a test session
post
Reopen a closed test session
get
Get all test groups for a session
post
Add a new test group to a session
get
Get a specific test group
get
Get all test cases for a test group
get
Get a specific test case
get
Get unit test suite token
User API
14
get
Returns the details of the authorized user
patch
Updates the authorized user
get
Get user's email addresses
post
Add email address to user account
delete
Delete an email address
get
Get user's SSH keys
post
Registers a new public SSH key for the authorized user
get
Returns the public SSH key of the authorized user
delete
Deletes a public SSH key of the authorized user
get
Get personal access token used for authorization
get
Get list of personal access tokens
post
Add personal access token
get
Get personal access token by ID
delete
Delete personal access token
Variable API
5
get
Returns the list of defined environment variables. If no query params are set, returns only workspace-scoped variables
post
Add a new environment variable
get
Shows details of the environment variable. Restricted to admins only
delete
Delete a variable
patch
Edits an environment variable
Visual Test API
4
get
Get all visual test suites for a project
post
Add a new visual test suite to a project
delete
Delete a visual test suite
get
Get visual test suite token
Webhook API
5
get
Get all webhooks in the workspace
post
Creates a new webhook. Restricted to admins only.
get
Get a specific webhook by ID
delete
Delete a webhook
patch
Update webhook configuration
Workspace API
18
get
Get all workspaces accessible to the user
get
Get a specific workspace by domain
post
Disable SSO for the workspace
post
Enable SSO for the workspace
get
Get the ID of an object using its human-readable identifier
get
Get all integrations in specified scope
post
Add a new integration to the workspace
get
Get a specific integration by hash ID
delete
Delete an integration
patch
Update integration configuration
get
Get all members in the workspace
post
Add a new member to the workspace
get
Get a specific workspace member by ID
delete
Remove a member from the workspace
patch
Update workspace member configuration
get
Get all projects accessible to a workspace member
get
Get SSO configuration
patch
Update SSO configuration