Superblocks

https://docs.superblocks.com/
Admin
Superblocks is a platform for rapidly building, deploying, and managing internal applications,...
Tokens:623,211
Snippets:2,952
Trust Score:9.8
Update:1 year ago
Show doc for...
Tokens:
Raw
### Create Example Component

Source: https://docs.superblocks.com/applications/custom-components/quickstart

Initializes a new custom component locally using the Superblocks CLI, with an option to create an example component.

```shell
superblocks components create --example
```

--------------------------------

### Install Superblocks React SDK

Source: https://docs.superblocks.com/applications/embedded-apps/quickstart

Installs the Superblocks React SDK using npm. This is the first step for embedding an app using React.

```bash
npm install --save @superblocksteam/embed-react
```

--------------------------------

### Install Superblocks JavaScript SDK

Source: https://docs.superblocks.com/applications/embedded-apps/quickstart

Installs the Superblocks JavaScript SDK using npm. This is the first step for embedding an app using plain JavaScript.

```bash
npm install --save @superblocksteam/embed
```

--------------------------------

### Start Superblocks Agent

Source: https://docs.superblocks.com/on-premise-agent/deployment/virtual_machine

Starts the Superblocks agent service. On the first run, this command also installs Docker and pulls the necessary Docker images for the agent.

```shell
sudo superblocks start

```

--------------------------------

### Configure Chart for Monthly Revenue Aggregation

Source: https://docs.superblocks.com/getting-started/5-min-quickstart-guide

This describes the configuration steps for a chart component to display monthly revenue. It involves setting the Y-axis to 'Price', aggregating the values by 'Sum', and setting the X-axis time granularity to 'Monthly'. This transforms raw order data into a time-series revenue visualization.

```configuration
Y axis: remove `id` series, keep only Price.
Y aggregation: select `Sum`.
X axis Styles > X time granularity: select `Monthly`.
```

--------------------------------

### Fetch Orders by Product Name using SQL

Source: https://docs.superblocks.com/getting-started/5-min-quickstart-guide

This SQL query retrieves all orders from the 'orders' table. It filters the results based on a product name, allowing for dynamic filtering. If the dropdown selection is empty, it defaults to fetching all orders. The `{{Dropdown1.selectedOptionValue || '%'}}` syntax allows referencing UI component values and provides a default.

```sql
SELECT *  
FROM orders  
WHERE product like {{Dropdown1.selectedOptionValue || '%'}}
```

--------------------------------

### Display Orders Table with Formatted Columns

Source: https://docs.superblocks.com/getting-started/5-min-quickstart-guide

This outlines the process of displaying order data in a table component. It involves binding the table data to an API response and then formatting specific columns. The 'image' column is set to display images, 'date_purchased' is formatted for readability, and 'user_id' is hidden to simplify the view.

```table-formatting
Table Data property: {{getOrders.response}}
Column 'image' Type: Image
Column 'date_purchased' Type: Date, Display Date Format: Do MMM YYYY
Hide Column 'user_id'
```

--------------------------------

### Query Product Names from Postgres

Source: https://docs.superblocks.com/getting-started/5-min-quickstart-guide

This SQL query retrieves a distinct list of product names from the 'orders' table in a PostgreSQL database. It's used to populate a dropdown component in Superblocks.

```sql
SELECT DISTINCT product
FROM orders
```

--------------------------------

### Install Ant Design Icons for React

Source: https://docs.superblocks.com/applications/custom-components/quickstart

Installs the Ant Design Icons library, which provides a collection of icons that can be used in React applications. This is a necessary step before importing and using specific icons.

```bash
npm install @ant-design/icons  
```

--------------------------------

### Trigger API on Dropdown Option Change

Source: https://docs.superblocks.com/getting-started/5-min-quickstart-guide

This configures an event handler for a dropdown component. When the selected option changes, it triggers the 'getOrders' API to fetch updated data. This ensures that the chart and table are re-filtered based on the user's dropdown selection.

```event-handling
Component: Product dropdown
Event: onOptionChange
Action: Run APIs > getOrders
```

--------------------------------

### Example Superblocks Log Entry

Source: https://docs.superblocks.com/development-lifecycle/monitor/monitoring-and-alerting

Provides a sample JSON object representing a log entry from a Superblocks agent, illustrating the expected format and data for an API start event.

```json
{
    "agent-id": "018cd5aa-6b42-7f68-9384-e691f254a425",
    "agent-version": "v0.1282.0",
    "component": "orchestrator",
    "correlation-id": "018cda86-2ff2-7f70-b6c9-038b0c4b34a1",
    "level": "info",
    "message": "The api API1 has been started.",
    "organization-id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "profile": "production",
    "resource-action": "started",
    "resource-id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "resource-name": "API1",
    "resource-type": "api",
    "service": "superblocks",
    "source": "superblocks",
    "timestamp": 1701377369695,
    "user-email": "name@company.com",
    "user-type": "superblocks"
  }
```

--------------------------------

### Superblocks CLI: Install and Login

Source: https://docs.superblocks.com/development-lifecycle/source-control/deploy

Commands to install the Superblocks CLI globally using npm and then log in to the CLI service.

```bash
# Install the Superblocks CLI globally
npm i -g @superblocksteam/cli

# Log in to the CLI
superblocks login

```

--------------------------------

### Example of Route Naming Conventions

Source: https://docs.superblocks.com/applications/multi-page/routes

Provides an example of a route that adheres to Superblocks' recommended naming conventions, using lowercase, dashes for separators, and camelCase for route parameters.

```text
/payment-methods/:methodType
```

--------------------------------

### Install Python Project Dependencies

Source: https://docs.superblocks.com/development-lifecycle/test/testing-apis

Installs the Python dependencies listed in the 'requirements.txt' file using pip3. This command ensures all necessary libraries for testing are available.

```bash
pip3 install -r requirements.txt
```

--------------------------------

### Install JavaScript Project Dependencies

Source: https://docs.superblocks.com/development-lifecycle/test/testing-apis

Installs all the project dependencies listed in the 'package.json' file using npm. This command is essential after configuring the project and adding dependencies.

```bash
npm install
```

--------------------------------

### Initialize Superblocks Repository

Source: https://docs.superblocks.com/applications/custom-components/quickstart

Creates a new local directory for Superblocks resources and navigates into it. This sets up the local environment for application development. Requires specifying an application URL.

```bash
mkdir [MY_SUPERBLOCKS_DIRECTORY]
cd [MY_SUPERBLOCKS_DIRECTORY]
```

```bash
superblocks init [MY_APPLICATION_URL] -m latest-edits
```

```bash
superblocks init https://app.superblocks.com/applications/c9d060f6-66a3-4859-9008-f2d069c91cf9/pages/3318ed66-e1e8-4187-8c51-93ef3b2a1d6d/edit -m latest-edits
```

--------------------------------

### Get Issue Worklogs

Source: https://docs.superblocks.com/integrations/integrations-library/jira

Returns worklogs for an issue, optionally starting from a specific date and time.

```APIDOC
## GET /rest/api/2/issue/{issueIdOrKey}/worklog

### Description
Returns worklogs for an issue, starting from the oldest worklog or from the worklog started on or after a date and time. Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see [Configuring time tracking](https://confluence.atlassian.com/x/qoXKM). This operation can be accessed anonymously.

### Permissions Required
Workloads are only returned where the user has:
* Browse projects [project permission] for the project that the issue is in.
* If issue-level security is configured, issue-level security permission to view the issue.
* If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
```

--------------------------------

### Download and Execute Superblocks Agent Script

Source: https://docs.superblocks.com/on-premise-agent/deployment/virtual_machine

Downloads the Superblocks agent installation script from GitHub, saves it to /usr/bin/superblocks, and makes it executable. This is the initial step for installing the agent on a VM.

```shell
sudo curl -SL https://raw.githubusercontent.com/superblocksteam/agent/main/scripts/quickstart.sh -o /usr/bin/superblocks

```

```shell
sudo chmod +x /usr/bin/superblocks

```

--------------------------------

### Example of checking Superblocks NAT IP addresses using dig

Source: https://docs.superblocks.com/security/overview_tab=cloud-only

This command-line example demonstrates how to retrieve the current IP addresses associated with the Superblocks NAT hostname using the 'dig' utility. This is the recommended method for maintaining an updated allowlist for integrations.

```bash
dig +short nat.superblocks.com A
dig +short nat.eu.superblocks.com A
```

--------------------------------

### Update Component Header

Source: https://docs.superblocks.com/applications/custom-components/quickstart

An example of updating the header text within the component's React code for hot-reloading.

```jsx
<h2>To-Do List</h2>
```

--------------------------------

### Superblocks CLI: Initialize and Export Tools

Source: https://docs.superblocks.com/development-lifecycle/source-control/deploy

Commands to create a directory for Superblocks tools (Apps, Workflows, Jobs), navigate into it, and then initialize the export process using a resource URL.

```bash
# Create a directory for you Apps, Workflows, and Jobs
mkdir superblocks_tools
cd superblocks_tools

# Export your tools
superblocks init [RESOURCE_URL]

```

--------------------------------

### Parse User UUID and Event Time with Python

Source: https://docs.superblocks.com/workflows/workflow-guides/calendly-slack

This Python script extracts the User UUID and formats the event start time into a readable string. It parses the user URL to get the UUID and uses the `time` module to convert the ISO 8601 start time into a human-readable format.

```python
import time

user = getEventDetails.output.resource.event_memberships[0].user.split("/") #split across the / to make a list

struct_time_event = time.strptime(str(getEventDetails.output.resource.start_time), '%Y-%m-%dT%H:%M:%S.%fZ')
mktime = time.mktime(struct_time_event)
readable_time = time.ctime(mktime)
return [user[4],readable_time] #pull the uuid from this position, the URL is static
```

--------------------------------

### Create and Populate 'example_table' (SQL)

Source: https://docs.superblocks.com/applications/application-guides/table-crud-guide

This SQL script creates a table named 'example_table' with 'id', 'name', and 'age' columns and inserts sample data. It first drops the table if it exists to ensure a clean state. This is useful for setting up a test environment.

```sql
DROP TABLE IF EXISTS example_table;
CREATE TABLE example_table (
id INT PRIMARY KEY,
name VARCHAR(50),
age INT
);
INSERT INTO example_table (id, name, age) VALUES
(1, 'Alice', 25),
(2, 'Bob', 30),
(3, 'Charlie', 35);
```

--------------------------------

### Get Issue Worklogs (Jira API)

Source: https://docs.superblocks.com/integrations/integrations-library/jira

Retrieves all worklogs associated with a Jira issue. This operation requires time tracking to be enabled in Jira. Worklogs can be filtered by a start date.

```curl
curl --request GET \
  --url 'https://your-domain.atlassian.net/rest/api/3/issue/{issueIdOrKey}/worklog' \
  --header 'Accept: application/json'
```

--------------------------------

### Superblocks CLI Upload Command

Source: https://docs.superblocks.com/applications/custom-components/quickstart

This command uploads a custom component to Superblocks, making it accessible outside of the local development environment. Ensure you are in the correct project directory when running this command.

```bash
superblocks components upload  
```

--------------------------------

### Example Usage: Upload CSV and display in Table

Source: https://docs.superblocks.com/applications/components-library/file-picker

A step-by-step guide on how to use the FilePicker to import CSV files and display them in a table, including restricting file types.

```APIDOC
## Example Usage: Upload CSV and display in Table

### Use FilePicker to import files

1.  Drag a **Container** component onto the canvas.
2.  Add a **FilePicker** component inside the Container.
3.  Add a **Button** component inside the Container. Set its **Label** to `Load File`.
4.  Add a **Text** component inside the Container. Set its **Text** to `Add the Recipes CSV` and its **Text Size** to `Heading 2`.

To configure the **FilePicker** to only allow specific file types:

1.  Select the **FilePicker** widget. In the **Properties panel**, change **Selection type** to `Single select`.
2.  Update **Allowed file types** to `[".csv", ".txt"]`.

After these steps, only `.txt` and `.csv` files will be available for selection when the user clicks `browse files`.
```

--------------------------------

### Update Google Sheets: Get Starting Row Number

Source: https://docs.superblocks.com/integrations/integrations-library/google-sheets_tab=service_account

This code snippet calculates the starting row number for updating a specific row in Google Sheets. It's used when a user selects a row in a Superblocks table, ensuring the update targets the correct location. It relies on the table's selected row index.

```jinja
{{ TABLE_NAME.filteredOrderMap[TABLE_NAME.selectedRowIndex] + 2 }}
```

--------------------------------

### Login to Superblocks Account

Source: https://docs.superblocks.com/applications/custom-components/quickstart

Authenticates your local environment with your Superblocks account using the CLI. The default domain is app.superblocks.com, but can be configured using `superblocks config set domain {domain}`.

```bash
superblocks login
```

--------------------------------

### Set Front-channel Logout URL in Entra for Superblocks

Source: https://docs.superblocks.com/administration/security/single-sign-on/azure-ad

Configure the Front-channel logout URL in your Entra application settings to enable seamless single sign-out from Superblocks.

```text
https://app.superblocks.com/logout
```

--------------------------------

### Update signInURL in Entra Manifest for IdP-Initiated Login

Source: https://docs.superblocks.com/administration/security/single-sign-on/azure-ad

Modify the `signInURL` property in the Entra application manifest to allow users to initiate login to Superblocks directly from Entra.

```json
{
    "signInURL": "https://app.superblocks.com?connection={MyCompanyName}-AzureAD"
}
```

--------------------------------

### List Environment Variables for Deployment

Source: https://docs.superblocks.com/integrations/integrations-library/bitbucket

Fetches deployment environment-level variables.

```HTTP
GET /repositories/{workspace}/{repo_slug}/deployments/{deployment_id}/variables
```

--------------------------------

### Configure EU Logout URL for Superblocks SSO in Entra

Source: https://docs.superblocks.com/administration/security/single-sign-on/azure-ad

For customers using the Superblocks EU instance, set the specified logout URL in your Entra application settings.

```text
https://eu.superblocks.com/logout
```

--------------------------------

### Confluence Cloud Setup

Source: https://docs.superblocks.com/integrations/integrations-library/confluence

Steps to set up Confluence Cloud integration in Superblocks, including creating an API token and configuring the integration.

```APIDOC
## Confluence Cloud Setup

### Description

This section outlines the process of setting up the Confluence Cloud integration within Superblocks. It involves generating an API token from your Atlassian account and then configuring the integration in the Superblocks web app.

### Create an Access Token

1. Log in to your Atlassian account and navigate to the [API Tokens page](https://id.atlassian.com/manage-profile/security/api-tokens).
2. Click **Create API token**.
3. **Label** the API token (e.g., 'Superblocks Integration') and click **Create**.
4. Use your Atlassian account **email** as the username and the generated **API Key** as the password in the Superblocks integration configuration.

### Add Integration in Superblocks

1. In the Superblocks web app, navigate to the **Integrations** page.
2. Click on the **Confluence Cloud API** tile.
3. **Name** your integration (e.g., 'My Confluence').
4. Paste your Confluence Cloud credentials (email and API token) into the relevant fields.
5. Optionally, configure credentials for different environments.
6. Click **Create**.

**Confluence Cloud connected!** You can now use Confluence Cloud actions in Superblocks Applications, Workflows, or Scheduled Jobs.
```

--------------------------------

### Create an environment

Source: https://docs.superblocks.com/integrations/integrations-library/bitbucket

Creates a new environment for the repository.

```APIDOC
## POST /websites/superblocks/environments

### Description
Creates a new environment for the repository.

### Method
POST

### Endpoint
/websites/superblocks/environments

### Parameters
#### Request Body
- **name** (string) - Required - The name of the environment to create.

### Request Example
```json
{
  "name": "Development"
}
```

### Response
#### Success Response (201 Created)
- **name** (string) - The name of the created environment.
- **id** (string) - The unique identifier of the created environment.

### Response Example
```json
{
  "name": "Development",
  "id": "dev-env"
}
```
```

--------------------------------

### Configure Redirect URI for Superblocks SSO in Entra

Source: https://docs.superblocks.com/administration/security/single-sign-on/azure-ad

Set the Web redirect URI in your Entra application registration to ensure proper callback handling during the SSO flow with Superblocks.

```text
https://login.superblocks.com/login/callback
```

--------------------------------

### List variables for an environment

Source: https://docs.superblocks.com/integrations/integrations-library/bitbucket

Finds deployment environment-level variables.

```APIDOC
## GET /repositories/{workspace}/{repo_slug}/environments/{environment_uuid}/variables

### Description
Finds deployment environment-level variables.

### Method
GET

### Endpoint
/repositories/{workspace}/{repo_slug}/environments/{environment_uuid}/variables

### Parameters
#### Path Parameters
- **workspace** (string) - Required - The workspace ID or unescaped name of the workspace.
- **repo_slug** (string) - Required - The repository's slug or unescaped name.
- **environment_uuid** (string) - Required - The UUID of the environment.

### Response
#### Success Response (200)
- **variables** (array) - A list of variable objects.

#### Response Example
{
  "variables": [
    {"key": "API_KEY", "value": "******"}
  ]
}
```

--------------------------------

### Include Superblocks Embed Script

Source: https://docs.superblocks.com/applications/embedded-apps/quickstart

Includes the Superblocks embed script directly into the head of an HTML page via a CDN link. This allows using the JavaScript embed functionality without installing the SDK.

```html
<script src="https://prod-cdn.superblocks.com/packages/@superblocksteam/embed@latest/embed.bundle.js"></script>
```

--------------------------------

### Get Thumbnail Batch with Dropbox API

Source: https://docs.superblocks.com/integrations/integrations-library/dropbox

Provides an example of fetching thumbnails for multiple images simultaneously from Dropbox using the Superblocks API. This method supports up to 25 thumbnails per batch and requires the 'files.content.read' scope.

```javascript
fetch("https://content.dropboxapi.com/2/files/get_thumbnail_batch", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "entries": [
      { "path": "/Photos/image1.png", "format": "png", "size": "w128h128" },
      { "path": "/Photos/image2.jpeg", "format": "jpeg", "size": "w256h256" }
    ]
  })
}).then(response => response.json()).then(data => {
  // Handle the batch thumbnail data
});
```

--------------------------------

### Start Generation (Image-to-Video)

Source: https://docs.superblocks.com/integrations/integrations-library/stabilityai

Initiates the generation of a short video based on an initial image using Stable Video Diffusion. Requires an API key in the authorization header and a multipart/form-data request body.

```APIDOC
## POST /v2beta/image-to-video

### Description
Generate a short video based on an initial image with Stable Video Diffusion.

### Method
POST

### Endpoint
/v2beta/image-to-video

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **image** (file) - Required - The initial image for video generation.
- **seed** (integer) - Optional - Controls the randomness of the generation.
- **cfg_scale** (number) - Optional - Controls how closely the generation follows the prompt.
- **motion_bucket_id** (integer) - Optional - Influences the motion characteristics of the video.

### Request Example
```json
{
  "image": "<binary data>",
  "seed": 12345,
  "cfg_scale": 7.5,
  "motion_bucket_id": 127
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the generation job.
- **status** (string) - The current status of the generation.

#### Response Example
```json
{
  "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "status": "processing"
}
```

### Credits
Flat rate of 20 credits per successful generation. Failed generations are not charged.
```

--------------------------------

### List Deployments

Source: https://docs.superblocks.com/integrations/integrations-library/bitbucket

Finds and lists existing deployments.

```HTTP
GET /repositories/{workspace}/{repo_slug}/deployments
```

--------------------------------

### Agent Tag Examples for Profiles

Source: https://docs.superblocks.com/on-premise-agent/deployment/multiple_environments

Examples of agent tag values to execute APIs for specific profiles or multiple profiles. The wildcard '*' executes APIs for all profiles.

```bash
# Execute APIs for the production profile
"profile:production"

# Execute APIs for both the development and staging profiles
"profile:development,profile:staging"

# Execute APIs for all profiles (default)
"profile:*"

```

--------------------------------

### GET /api/v1/synthetics/global-variables/{variable_id}

Source: https://docs.superblocks.com/integrations/integrations-library/datadog

Get a global variable. Get the detailed configuration of a global variable.

```APIDOC
## GET /api/v1/synthetics/global-variables/{variable_id}

### Description
Retrieves the detailed configuration of a global variable.

### Method
GET

### Endpoint
/api/v1/synthetics/global-variables/{variable_id}

### Parameters
#### Path Parameters
- **variable_id** (string) - Required - The ID of the global variable.

### Response
#### Success Response (200)
- **variable_configuration** (object) - Detailed configuration of the global variable.

#### Response Example
```json
{
  "id": "variable_id",
  "name": "Global Variable",
  "value": "value"
}
```

#### Error Response (404)
- Global variable not found.

#### Error Response (500)
- Internal server error.

```

--------------------------------

### GET /api/v1/synthetics/tests/{test_id}

Source: https://docs.superblocks.com/integrations/integrations-library/datadog

Get a test configuration. Get the detailed configuration associated with a Synthetic test.

```APIDOC
## GET /api/v1/synthetics/tests/{test_id}

### Description
Retrieves the detailed configuration associated with a Synthetic test.

### Method
GET

### Endpoint
/api/v1/synthetics/tests/{test_id}

### Parameters
#### Path Parameters
- **test_id** (string) - Required - The ID of the test.

### Response
#### Success Response (200)
- **test_configuration** (object) - Detailed configuration of the test.

#### Response Example
```json
{
  "id": "test_id",
  "name": "Test",
  "type": "api",
  "request": {
    "method": "GET",
    "url": "https://example.com/api"
  }
}
```

#### Error Response (404)
- Test not found.

#### Error Response (500)
- Internal server error.

```

--------------------------------

### Create metadata instance on file

Source: https://docs.superblocks.com/integrations/integrations-library/box

Applies a metadata template instance to a file. Most templates accept only predefined values, except for `global.properties` which accepts any key-value pair.

```shell
POST "/files/:id/metadata/:scope/:template_key"

```

--------------------------------

### Create Project

Source: https://docs.superblocks.com/integrations/integrations-library/launchdarkly

Creates a new project with a unique key and name within an account.

```bash
POST /projects
{
  "key": "your-project-key",
  "name": "Your Project Name"
}
```

--------------------------------

### GET /api/v1/synthetics/tests/api/{test_id}

Source: https://docs.superblocks.com/integrations/integrations-library/datadog

Get an API test. Get the detailed configuration associated with a Synthetic API test.

```APIDOC
## GET /api/v1/synthetics/tests/api/{test_id}

### Description
Retrieves the detailed configuration associated with a Synthetic API test.

### Method
GET

### Endpoint
/api/v1/synthetics/tests/api/{test_id}

### Parameters
#### Path Parameters
- **test_id** (string) - Required - The ID of the API test.

### Response
#### Success Response (200)
- **test_configuration** (object) - Detailed configuration of the API test.

#### Response Example
```json
{
  "id": "test_id",
  "name": "API Test",
  "type": "api",
  "request": {
    "method": "GET",
    "url": "https://example.com/api"
  }
}
```

#### Error Response (404)
- API test not found.

#### Error Response (500)
- Internal server error.

```

--------------------------------

### GET /websites/superblocks/project/environments

Source: https://docs.superblocks.com/integrations/integrations-library/launchdarkly

Lists all environments for a specified project, with support for pagination and filtering.

```APIDOC
## GET /websites/superblocks/project/environments

### Description
Return a list of environments for the specified project. By default, this returns the first 20 environments. Page through this list with the `limit` parameter and by following the `first`, `prev`, `next`, and `last` links in the `_links` field that returns.

### Method
GET

### Endpoint
`/websites/superblocks/project/{projectKey}/environments`

### Parameters
#### Path Parameters
- **projectKey** (string) - Required - The unique key of the project.

#### Query Parameters
- **limit** (integer) - Optional - The maximum number of environments to return per page. Default is 20.
- **offset** (integer) - Optional - The number of environments to skip before returning results.
- **filter** (string) - Optional - Filters environments by name or key (`query:`), and/or tags (`tags:`). Tags are a `+`-separated list. Example: `query:staging,tags:prod+eu`.
- **sort** (string) - Optional - Sorts the environments by `name` or `createdOn` in ascending order.
```

--------------------------------

### GET /api/v1/synthetics/tests/browser/{test_id}

Source: https://docs.superblocks.com/integrations/integrations-library/datadog

Get a browser test. Get the detailed configuration (including steps) associated with a Synthetic browser test.

```APIDOC
## GET /api/v1/synthetics/tests/browser/{test_id}

### Description
Retrieves the detailed configuration (including steps) associated with a Synthetic browser test.

### Method
GET

### Endpoint
/api/v1/synthetics/tests/browser/{test_id}

### Parameters
#### Path Parameters
- **test_id** (string) - Required - The ID of the browser test.

### Response
#### Success Response (200)
- **test_configuration** (object) - Detailed configuration of the browser test.

#### Response Example
```json
{
  "id": "test_id",
  "name": "Browser Test",
  "type": "browser",
  "steps": [
    {
      "type": "click",
      "target": "button"
    }
  ]
}
```

#### Error Response (404)
- Browser test not found.

#### Error Response (500)
- Internal server error.

```

--------------------------------

### POST /websites/superblocks/project/environments

Source: https://docs.superblocks.com/integrations/integrations-library/launchdarkly

Creates a new environment within a project, specifying its name, key, color, and default TTL.

```APIDOC
## POST /websites/superblocks/project/environments

### Description
Create a new environment in a specified project with a given name, key, swatch color, and default TTL.

### Method
POST

### Endpoint
`/websites/superblocks/project/{projectKey}/environments`

### Parameters
#### Path Parameters
- **projectKey** (string) - Required - The unique key of the project.

#### Request Body
- **name** (string) - Required - The name of the environment.
- **key** (string) - Required - The unique key of the environment.
- **color** (string) - Optional - The swatch color for the environment (e.g., "blue", "#0000ff").
- **defaultTtl** (integer) - Optional - The default Time To Live for feature flags in this environment in seconds.
```

--------------------------------

### Create project

Source: https://docs.superblocks.com/integrations/integrations-library/launchdarkly

Create a new project with a unique key and a given name.

```APIDOC
## POST /websites/superblocks/projects

### Description
Create a new project with the given key and name.

### Method
POST

### Endpoint
/websites/superblocks/projects

### Parameters
#### Request Body
- **key** (string) - Required - The unique key for the project.
- **name** (string) - Required - The name of the project.

### Request Example
```json
{
  "key": "new-project-key",
  "name": "New Project Name"
}
```

### Response
#### Success Response (201)
- **project** (object) - The newly created project object.
  - **key** (string) - The unique key of the project.
  - **name** (string) - The name of the project.

#### Response Example
```json
{
  "project": {
    "key": "new-project-key",
    "name": "New Project Name"
  }
}
```
```

--------------------------------

### GitHub Actions Workflow for Running Superblocks Tests

Source: https://docs.superblocks.com/development-lifecycle/test/testing-apis

This GitHub Actions workflow demonstrates how to set up Node.js and Python environments to run Superblocks API tests. It includes checkout, environment setup, dependency installation, and test execution for both JavaScript (npm test) and Python (pytest). The SUPERBLOCKS_EXECUTION_TOKEN is securely passed as an environment secret.

```yaml
name: Sync changes to Superblocks
on: [push]

env:
  SUPERBLOCKS_AGENT_HOST: agent.superblocks.com
  SUPERBLOCKS_VIEW_MODE: preview
  BRANCH: ${{ git.ref_name }}

jobs:
  ...

  # Run JavaScript Tests
  run-js-tests:
    runs-on: ubuntu-latest
    needs: superblocks-sync
    steps:
      - name: checkout
        uses: actions/checkout@v4

      - name: setup node
        uses: actions/setup-node@v4

      - name: run js tests
        run: |
          npm install
          npm test
        env:
          SUPERBLOCKS_EXECUTION_TOKEN: ${{ secrets.SUPERBLOCKS_EXECUTION_TOKEN }}

  # Run Python Tests
  run-py-tests:
    runs-on: ubuntu-latest
    needs: superblocks-sync
    steps:
      - name: checkout
        uses: actions/checkout@v4

      - name: set up python
        uses: actions/setup-python@v5
        with:
          python-version: "3.10"

      - name: run python tests
        run: |
          pip3 install -r requirements.txt
          pytest
        env:
          SUPERBLOCKS_EXECUTION_TOKEN: ${{ secrets.SUPERBLOCKS_EXECUTION_TOKEN }}
```

--------------------------------

### GET /api/v1/synthetics/tests/api/{test_id}/results/{result_id}

Source: https://docs.superblocks.com/integrations/integrations-library/datadog

Get an API test result. Get a specific full result from a given Synthetic API test.

```APIDOC
## GET /api/v1/synthetics/tests/api/{test_id}/results/{result_id}

### Description
Retrieves a specific full result from a given Synthetic API test.

### Method
GET

### Endpoint
/api/v1/synthetics/tests/api/{test_id}/results/{result_id}

### Parameters
#### Path Parameters
- **test_id** (string) - Required - The ID of the API test.
- **result_id** (string) - Required - The ID of the test result.

### Response
#### Success Response (200)
- **test_result** (object) - Detailed test result.

#### Response Example
```json
{
  "result_id": "result_id",
  "status": "pass",
  "details": {
    "response_time": 100
  }
}
```

#### Error Response (404)
- API test or result not found.

#### Error Response (500)
- Internal server error.

```

--------------------------------

### GET /api/v1/synthetics/tests/browser/{test_id}/results/{result_id}

Source: https://docs.superblocks.com/integrations/integrations-library/datadog

Get a browser test result. Get a specific full result from a given Synthetic browser test.

```APIDOC
## GET /api/v1/synthetics/tests/browser/{test_id}/results/{result_id}

### Description
Retrieves a specific full result from a given Synthetic browser test.

### Method
GET

### Endpoint
/api/v1/synthetics/tests/browser/{test_id}/results/{result_id}

### Parameters
#### Path Parameters
- **test_id** (string) - Required - The ID of the browser test.
- **result_id** (string) - Required - The ID of the test result.

### Response
#### Success Response (200)
- **test_result** (object) - Detailed test result.

#### Response Example
```json
{
  "result_id": "result_id",
  "status": "pass",
  "steps": [
    {
      "step_id": "step_id_1",
      "status": "pass"
    }
  ]
}
```

#### Error Response (404)
- Browser test or result not found.

#### Error Response (500)
- Internal server error.

```

--------------------------------

### Data URL Examples for File Types

Source: https://docs.superblocks.com/applications/components-library/file-picker

Provides examples of Data URLs for various file types, showing how to specify the correct media type for image, PDF, and other file formats when embedding data.

```text
jpeg| data:image/jpeg;base64," + file_content
```

```text
png| data:image/png;base64," + file_content
```

```text
gif| data:image/gif;base64," + file_content
```

```text
pdf| data:application/pdf;base64," + file_content
```

--------------------------------

### Get Filter in Destination

Source: https://docs.superblocks.com/integrations/integrations-library/segment

Gets a Destination filter by id.

```APIDOC
## GET /websites/superblocks/destinations/{destinationId}/filters/{filterId}

### Description
Gets a Destination filter by id.

### Method
GET

### Endpoint
/websites/superblocks/destinations/{destinationId}/filters/{filterId}

### Parameters
#### Path Parameters
- **destinationId** (string) - Required - The ID of the destination.
- **filterId** (string) - Required - The ID of the filter.

### Response
#### Success Response (200)
- **id** (string) - The ID of the filter.
- **name** (string) - The name of the filter.
- **enabled** (boolean) - Whether the filter is enabled.

#### Response Example
```json
{
  "id": "filter_xyz",
  "name": "Block Sensitive Data",
  "enabled": true
}
```
```

--------------------------------

### Create Product

Source: https://docs.superblocks.com/integrations/integrations-library/hubspot

Creates a new product with the specified properties and returns a copy of the created object, including its ID.

```APIDOC
## POST /websites/superblocks/products

### Description
Create a product with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard products is provided.

### Method
POST

### Endpoint
/websites/superblocks/products

### Parameters
#### Request Body
- **properties** (object) - Required - The properties of the product to be created.
```

--------------------------------

### GET /api/v1/synthetics/tests/api/{test_id}/results/summary

Source: https://docs.superblocks.com/integrations/integrations-library/datadog

Get an API test's latest results summaries. Get the last 150 test results summaries for a given Synthetic API test.

```APIDOC
## GET /api/v1/synthetics/tests/api/{test_id}/results/summary

### Description
Retrieves the last 150 test results summaries for a given Synthetic API test.

### Method
GET

### Endpoint
/api/v1/synthetics/tests/api/{test_id}/results/summary

### Parameters
#### Path Parameters
- **test_id** (string) - Required - The ID of the API test.

### Response
#### Success Response (200)
- **results** (array) - An array of test result summaries.

#### Response Example
```json
[
  {
    "result_id": "result_id_1",
    "status": "pass",
    "timestamp": "2024-01-01T00:00:00Z"
  },
  {
    "result_id": "result_id_2",
    "status": "fail",
    "timestamp": "2024-01-01T00:01:00Z"
  }
]
```

#### Error Response (404)
- API test not found.

#### Error Response (500)
- Internal server error.

```

--------------------------------

### Create Workspace Project

Source: https://docs.superblocks.com/integrations/integrations-library/bitbucket

Creates a new project within a workspace. The avatar can be provided as a data-URL or a URL to an external image.

```shell
# Example using curl (replace placeholders with actual values)
curl -X POST "https://api.bitbucket.org/2.0/workspaces/<workspace>/projects" \
     -H "Content-Type: application/json" \
     -d '{
       "name": "My New Project",
       "key": "MNP",
       "description": "This is a sample project.",
       "avatar": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA..."
     }'
```

--------------------------------

### GET /api/v1/synthetics/tests/browser/{test_id}/results/summary

Source: https://docs.superblocks.com/integrations/integrations-library/datadog

Get a browser test's latest results summaries. Get the last 150 test results summaries for a given Synthetic browser test.

```APIDOC
## GET /api/v1/synthetics/tests/browser/{test_id}/results/summary

### Description
Retrieves the last 150 test results summaries for a given Synthetic browser test.

### Method
GET

### Endpoint
/api/v1/synthetics/tests/browser/{test_id}/results/summary

### Parameters
#### Path Parameters
- **test_id** (string) - Required - The ID of the browser test.

### Response
#### Success Response (200)
- **results** (array) - An array of test result summaries.

#### Response Example
```json
[
  {
    "result_id": "result_id_1",
    "status": "pass",
    "timestamp": "2024-01-01T00:00:00Z"
  },
  {
    "result_id": "result_id_2",
    "status": "fail",
    "timestamp": "2024-01-01T00:01:00Z"
  }
]
```

#### Error Response (404)
- Browser test not found.

#### Error Response (500)
- Internal server error.

```

--------------------------------

### Get All Branches for a Project

Source: https://docs.superblocks.com/integrations/integrations-library/circleci

Get a list of all branches for a specified project.

```APIDOC
## GET /api/v2/insights/{project-slug}/branches

### Description
Get a list of all branches for a specified project. The list will only contain branches currently available within Insights. The maximum number of branches returned by this endpoint is 5,000.

### Method
GET

### Endpoint
/api/v2/insights/{project-slug}/branches

### Parameters
#### Path Parameters
- **project-slug** (string) - Required - The slug of the project (e.g., 'github-org-repo').

### Response
#### Success Response (200)
- **items** (array) - A list of branch names.

#### Response Example
{
  "items": [
    "main",
    "develop",
    "feature/new-UI"
  ]
}
```

--------------------------------

### GET /websites/superblocks/destinations/{destinationId}/delivery-metrics

Source: https://docs.superblocks.com/integrations/integrations-library/segment

Get an event delivery metrics summary from a Destination.

```APIDOC
## GET /websites/superblocks/destinations/{destinationId}/delivery-metrics

### Description
Get an event delivery metrics summary from a Destination.

### Method
GET

### Endpoint
/websites/superblocks/destinations/{destinationId}/delivery-metrics

### Parameters
#### Path Parameters
- **destinationId** (string) - Required - The ID of the destination.

#### Query Parameters
- **granularity** (string) - Required - The granularity of the metrics (e.g., 'Minute', 'Hour', 'Day').
- **startTime** (string) - Required - The start time for the query (ISO 8601 format).
- **endTime** (string) - Required - The end time for the query (ISO 8601 format).

#### Request Body
None

### Request Example
```json
{
  "message": "Delivery metrics summary retrieved successfully."
}
```

### Response
#### Success Response (200)
- **metrics** (object) - The delivery metrics summary.
  - **deliveredCount** (integer) - The number of successfully delivered events.
  - **failedCount** (integer) - The number of failed delivery events.
  - **successRate** (number) - The success rate of deliveries.

#### Response Example
```json
{
  "metrics": {
    "deliveredCount": 1000,
    "failedCount": 10,
    "successRate": 0.99
  }
}
```
```

--------------------------------

### Import Existing Users from Superblocks to Okta

Source: https://docs.superblocks.com/administration/security/scim/okta

Instructions on how to import existing users from your Superblocks organization into Okta for linking.

```APIDOC
## POST /users/import

### Description
Initiates an import of existing users from Superblocks into Okta to facilitate user linking and management.

### Method
POST

### Endpoint
`/users/import` (within the Okta Superblocks SCIM app)

### Parameters
#### Request Body
- **Import Option** (string) - Required - Specifies how to handle imported users (e.g., `Link to EXACT Okta user match`, `Link to NEW Okta user`, `IGNORE this user for now`).

### Request Example
```json
{
  "Import Option": "Link to EXACT Okta user match"
}
```

### Response
#### Success Response (200)
- **import_status** (string) - The status of the user import process.
- **imported_users_count** (integer) - The number of users successfully imported.

#### Response Example
```json
{
  "import_status": "completed",
  "imported_users_count": 150
}
```

### Error Handling
- **400 Bad Request**: Invalid import option provided.
- **500 Internal Server Error**: An error occurred during the import process.
```

--------------------------------

### Get Regulation

Source: https://docs.superblocks.com/integrations/integrations-library/segment

Gets a regulation from the Workspace. The `parent` field is omitted by the Config API.

```APIDOC
## GET /websites/superblocks/regulations/{regulationId}

### Description
Gets a regulation from the Workspace. The `parent` field is omitted by the Config API.

### Method
GET

### Endpoint
/websites/superblocks/regulations/{regulationId}

### Parameters
#### Path Parameters
- **regulationId** (string) - Required - The unique identifier of the regulation.

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the regulation.
- **name** (string) - The name of the regulation.

#### Response Example
{
  "id": "reg-12345",
  "name": "My Workspace Regulation"
}
```

--------------------------------

### List download artifacts

Source: https://docs.superblocks.com/integrations/integrations-library/bitbucket

Returns a paginated list of download links associated with the repository.

```APIDOC
## GET /websites/superblocks/downloads

### Description
Returns a paginated list of download links associated with the repository.

### Method
GET

### Endpoint
/websites/superblocks/downloads

### Response
#### Success Response (200)
- **values** (array) - A list of download artifact objects.
  - **name** (string) - The name of the artifact.
  - **path** (string) - The URL to download the artifact.
  - **size** (integer) - The size of the artifact in bytes.
  - **created_on** (string) - The timestamp when the artifact was created.

### Response Example
```json
{
  "values": [
    {
      "name": "example.zip",
      "path": "https://api.bitbucket.org/2.0/repositories/user/repo/downloads/example.zip",
      "size": 10240,
      "created_on": "2023-10-27T10:00:00+00:00"
    }
  ]
}
```
```

--------------------------------

### GET /api/v1/tags/configuration

Source: https://docs.superblocks.com/integrations/integrations-library/datadog

Get Tags. Return a mapping of tags to hosts for your whole infrastructure.

```APIDOC
## GET /api/v1/tags/configuration

### Description
Returns a mapping of tags to hosts for your whole infrastructure.

### Method
GET

### Endpoint
/api/v1/tags/configuration

### Response
#### Success Response (200)
- **tags_mapping** (object) - A mapping of tags to hosts.

#### Response Example
```json
{
  "tag1": ["host1", "host2"],
  "tag2": ["host3"]
}
```

#### Error Response (500)
- Internal server error.

```

--------------------------------

### Create a Webhook

Source: https://docs.superblocks.com/integrations/integrations-library/bitbucket

Creates a new webhook on a specified repository. Requires 'webhook' scope and scopes for subscribed events (e.g., 'repository', 'issue'). The URL must be resolvable.

```json
{
  "url": "http://example.com/webhook",
  "description": "Optional webhook description",
  "active": true,
  "events": [
    "repo:push",
    "issues:created"
  ]
}
```
Tokens:
Raw