### Download and Run SuperPlane Installer

Source: https://docs.superplane.com/installation/single-host/linode

Fetch the installation bundle and execute the setup script to initialize the SuperPlane environment.

```bash
wget -q https://install.superplane.com/superplane-single-host.tar.gz
tar -xf superplane-single-host.tar.gz
cd superplane
```

```bash
./install.sh
```

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

### Install Docker and Docker Compose on Ubuntu

Source: https://docs.superplane.com/installation/single-host/aws-ec2

Installs Docker CE, containerd.io, Docker Buildx plugin, and Docker Compose plugin on an Ubuntu instance. It updates package lists, adds the Docker GPG key, configures the Docker repository, and installs the necessary packages. Finally, it enables and starts the Docker service, and adds the current user to the `docker` group.

```bash
sudo apt update
sudo apt install -y ca-certificates curl gnupg
sudo install -m 0755 -d /etc/apt/keyrings
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | \
  sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg
sudo chmod a+r /etc/apt/keyrings/docker.gpg
echo \
  "deb [arch=$(dpkg --print-architecture) \
  signed-by=/etc/apt/keyrings/docker.gpg] \
  https://download.docker.com/linux/ubuntu \
  $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
  sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
sudo apt update
sudo apt install -y docker-ce docker-ce-cli containerd.io \
  docker-buildx-plugin docker-compose-plugin
sudo systemctl enable --now docker
sudo usermod -aG docker ubuntu
newgrp docker
```

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

### Run SuperPlane Single-Host Installer

Source: https://docs.superplane.com/installation/single-host/aws-ec2

Executes the SuperPlane single-host installation script. This script sets up the Docker Compose stack and starts SuperPlane on the instance.

```bash
./install.sh
```

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

### Cloud Build Configuration Examples

Source: https://docs.superplane.com/components/googlecloud

JSON configuration examples for defining build steps and source repositories in Cloud Build.

```json
[{"name":"gcr.io/cloud-builders/docker","args":["build","-t","gcr.io/$PROJECT_ID/myapp","."]}]
```

```json
{"gitSource":{"url":"https://github.com/org/repo.git","revision":"main"}}
```

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

### Install Docker and Docker Compose on Ubuntu

Source: https://docs.superplane.com/installation/single-host/generic-server

Installs Docker and its associated plugins using Docker's official repository on Ubuntu. Ensure Docker is enabled and running after installation.

```bash
apt update
apt install -y ca-certificates curl gnupg
install -m 0755 -d /etc/apt/keyrings
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | \
  gpg --dearmor -o /etc/apt/keyrings/docker.gpg
chmod a+r /etc/apt/keyrings/docker.gpg
echo \
  "deb [arch=$(dpkg --print-architecture) \
  signed-by=/etc/apt/keyrings/docker.gpg] \
  https://download.docker.com/linux/ubuntu \
  $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
  tee /etc/apt/sources.list.d/docker.list > /dev/null
apt update
apt install -y docker-ce docker-ce-cli containerd.io \
  docker-buildx-plugin docker-compose-plugin
systemctl enable --now docker
```

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

### Download and Unpack SuperPlane Installer

Source: https://docs.superplane.com/installation/single-host/aws-ec2

Downloads the SuperPlane single-host installer archive and unpacks it into the current directory. Navigates into the extracted `superplane` directory.

```bash
wget -q https://install.superplane.com/superplane-single-host.tar.gz
tar -xf superplane-single-host.tar.gz
cd superplane
```

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

### Honeycomb Create Event Example Output

Source: https://docs.superplane.com/components/honeycomb

This is an example of the output when an event is successfully sent to a Honeycomb dataset. It confirms the event details and status.

```json
{
  "data": {
    "dataset": "example",
    "fields": {
      "deployed_by": "github-actions",
      "duration_seconds": 42,
      "environment": "production",
      "event_type": "deployment",
      "service": "billing-api",
      "success": true,
      "version": "2.4.1"
    },
    "status": "sent"
  },
  "timestamp": "2026-02-27T11:34:29.510313029Z",
  "type": "honeycomb.event.created"
}
```

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

### Harness Run Pipeline Example Output

Source: https://docs.superplane.com/components/harness

Example JSON output after a Harness pipeline execution is completed via the Run Pipeline action. It includes details like execution ID, status, and URLs.

```json
{
  "data": {
    "endedAt": "2026-02-12T18:45:55Z",
    "executionId": "3y9YlBC9SrOn6W7bPT5nCw",
    "pipelineIdentifier": "deploy_prod",
    "planExecutionUrl": "https://app.harness.io/ng/account/acc123/module/cd/orgs/default/projects/platform/pipelines/deploy_prod/executions/3y9YlBC9SrOn6W7bPT5nCw/pipeline",
    "startedAt": "2026-02-12T18:42:10Z",
    "status": "succeeded"
  },
  "timestamp": "2026-02-12T18:45:55Z",
  "type": "harness.pipeline.finished"
}
```

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

### Add Memory Output Example

Source: https://docs.superplane.com/components/core

Example JSON output emitted by the Add Memory component after successfully appending data.

```json
{
  "data": {
    "data": {
      "namespace": "machines",
      "values": {
        "creator": "alex",
        "id": "1",
        "pull_request": "123"
      }
    }
  },
  "timestamp": "2026-01-19T12:00:00Z",
  "type": "memory.added"
}
```

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

### Install SuperPlane CLI (Latest)

Source: https://docs.superplane.com/installation/cli

Installs the latest SuperPlane CLI binary for macOS on ARM architecture. Ensure you have curl and chmod available.

```bash
curl -L https://install.superplane.com/superplane-cli-darwin-arm64 -o superplane
chmod +x superplane
sudo mv superplane /usr/local/bin/superplane
```

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

### Install SuperPlane Skills for AI Agents

Source: https://docs.superplane.com/

Install all SuperPlane skills for AI agents or a specific skill like the CLI. This enables AI agents to efficiently operate SuperPlane, including CLI usage and workflow debugging.

```bash
npx skills add superplanehq/skills
```

```bash
npx skills add superplanehq/skills --skill superplane-cli
```

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

### Get Flaky Tests Output

Source: https://docs.superplane.com/components/circleci

Example JSON payload containing a list of identified flaky tests and their associated metadata.

```json
{
  "data": {
    "flakyTests": [
      {
        "classname": "auth_test.go",
        "file": "pkg/auth/auth_test.go",
        "jobName": "test",
        "pipelineName": "build-pipeline",
        "source": "go",
        "testName": "TestUserAuthentication",
        "timesFlaky": 8,
        "workflowName": "build-test-deploy"
      },
      {
        "classname": "cache_test.go",
        "file": "pkg/cache/cache_test.go",
        "jobName": "test",
        "pipelineName": "build-pipeline",
        "source": "go",
        "testName": "TestCacheInvalidation",
        "timesFlaky": 3,
        "workflowName": "build-test-deploy"
      }
    ],
    "totalFlakyTests": 2
  },
  "timestamp": "2021-09-01T22:55:34.317Z",
  "type": "circleci.flakyTests"
}
```

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

### Create Repository Sandbox Output

Source: https://docs.superplane.com/components/daytona

Example JSON response returned after successfully creating a sandbox, cloning a repository, and running a bootstrap script.

```json
{
  "data": {
    "bootstrap": {
      "from": "file",
      "path": "scripts/bootstrap.sh"
    },
    "directory": "/home/daytona/example-app",
    "repository": "https://github.com/superplanehq/example-app.git",
    "sandboxId": "sandbox-abc123def456",
    "sandboxStartedAt": "2026-01-19T12:00:00Z",
    "secrets": [
      {
        "name": "API_KEY",
        "type": "env",
        "value": {
          "key": "API_KEY",
          "secret": "api-key-secret"
        }
      }
    ],
    "timeout": 300
  },
  "timestamp": "2026-01-19T12:00:00Z",
  "type": "daytona.repository.sandbox"
}
```

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

### Get Image Tag Example Output

Source: https://docs.superplane.com/components/dockerhub

Represents the metadata structure returned when querying details for a specific DockerHub image tag.

```json
{
  "data": {
    "full_size": 52837442,
    "id": 123456,
    "images": [
      {
        "architecture": "amd64",
        "digest": "sha256:fe12ab34cd56ef78ab90cd12ef34ab56cd78ef90ab12cd34ef56ab78cd90ef12",
        "last_pulled": "2025-01-06T11:02:10.123456Z",
        "last_pushed": "2025-01-05T21:06:53.506400Z",
        "os": "linux",
        "size": 52837442,
        "status": "active"
      }
    ],
    "last_updated": "2025-01-05T21:06:53.506400Z",
    "last_updater": 1234,
    "last_updater_username": "superplane-bot",
    "name": "latest",
    "repository": 98765,
    "status": "active",
    "tag_last_pulled": "2025-01-06T11:02:10.123456Z",
    "tag_last_pushed": "2025-01-05T21:06:53.506400Z",
    "v2": "true"
  },
  "timestamp": "2026-02-03T12:00:00Z",
  "type": "dockerhub.tag"
}
```

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

### Example App Creation Output

Source: https://docs.superplane.com/components/digitalocean

This JSON object represents the output received after a successful app creation. It includes the app's ID, name, default ingress URL, live URL, and deployment region.

```json
{
  "data": {
    "defaultIngress": "https://my-app-22-b6v8c.ondigitalocean.app",
    "id": "6d8abe1c-7cc5-4db3-b1aa-d9cdd1c127e7",
    "liveURL": "https://my-app-22-b6v8c.ondigitalocean.app",
    "name": "my-app-22",
    "region": {
      "continent": "Asia",
      "data_centers": [
        "blr1"
      ],
      "flag": "india",
      "label": "Bangalore",
      "slug": "blr"
    }
  },
  "timestamp": "2026-03-24T07:01:24.678254095Z",
  "type": "digitalocean.app.created"
}
```

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

### Discover integrations and components

Source: https://docs.superplane.com/installation/cli

Commands to list or describe available integrations, components, and triggers.

```bash
superplane index integrations
```

```bash
superplane index integrations --name <integration_name>
```

```bash
superplane index components
```

```bash
superplane index components --from <integration_name>
```

```bash
superplane index components --name <component_name>
```

```bash
superplane index triggers --from <integration_name>
```

```bash
superplane index triggers --name <trigger_name>
```

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

### Get Artifact Info Example Output

Source: https://docs.superplane.com/components/jfrogartifactory

This JSON provides detailed metadata for an artifact retrieved from JFrog Artifactory. It includes checksums, timestamps, and other identifying information.

```json
{
  "data": {
    "checksums": {
      "md5": "d41d8cd98f00b204e9800998ecf8427e",
      "sha1": "da39a3ee5e6b4b0d3255bfef95601890afd80709",
      "sha256": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
    },
    "created": "2026-01-15T10:30:00.000Z",
    "createdBy": "admin",
    "downloadUri": "https://mycompany.jfrog.io/artifactory/libs-release-local/com/example/artifact/1.0/artifact-1.0.jar",
    "lastModified": "2026-01-15T10:30:00.000Z",
    "mimeType": "application/java-archive",
    "modifiedBy": "admin",
    "path": "/com/example/artifact/1.0/artifact-1.0.jar",
    "repo": "libs-release-local",
    "size": "12345",
    "uri": "https://mycompany.jfrog.io/artifactory/api/storage/libs-release-local/com/example/artifact/1.0/artifact-1.0.jar"
  },
  "timestamp": "2026-01-23T12:00:00Z",
  "type": "jfrogArtifactory.artifact.info"
}
```

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

### Manual Run Trigger Example Data

Source: https://docs.superplane.com/components/core

This JSON object shows the empty event payload that a Manual Run trigger starts with, serving as a base for subsequent data manipulation.

```json
{
  "foo": "bar"
}
```

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

### Example Application Deployment Output

Source: https://docs.superplane.com/components/digitalocean

This JSON structure represents the output of an application deployment, detailing active and pending deployments, region information, and specifications.

```json
{
  "data": {
    "active_deployment": {
      "cause": "initial deployment",
      "created_at": "2026-03-24T10:17:51Z",
      "id": "a5ad056d-523a-48e2-9715-76db183f5a15",
      "phase": "ACTIVE",
      "progress": {
        "steps": [
          {
            "ended_at": "2026-03-24T10:18:56.473548704Z",
            "name": "build",
            "started_at": "2026-03-24T10:17:57.360621633Z",
            "status": "SUCCESS",
            "steps": [
              {
                "ended_at": "2026-03-24T10:18:23.527631658Z",
                "name": "initialize",
                "started_at": "2026-03-24T10:17:57.360716517Z",
                "status": "SUCCESS"
              },
              {
                "ended_at": "2026-03-24T10:18:54.938686340Z",
                "name": "components",
                "started_at": "2026-03-24T10:18:23.527664326Z",
                "status": "SUCCESS",
                "steps": [
                  {
                    "name": "my-app",
                    "status": "SUCCESS"
                  }
                ]
              }
            ]
          },
          {
            "ended_at": "2026-03-24T10:19:06.689255599Z",
            "name": "deploy",
            "started_at": "2026-03-24T10:19:02.998040282Z",
            "status": "SUCCESS",
            "steps": [
              {
                "ended_at": "2026-03-24T10:19:04.851886393Z",
                "name": "initialize",
                "started_at": "2026-03-24T10:19:02.998063884Z",
                "status": "SUCCESS"
              },
              {
                "ended_at": "2026-03-24T10:19:04.851934987Z",
                "name": "components",
                "started_at": "2026-03-24T10:19:04.851916324Z",
                "status": "SUCCESS"
              },
              {
                "ended_at": "2026-03-24T10:19:06.689152591Z",
                "name": "finalize",
                "started_at": "2026-03-24T10:19:04.852021129Z",
                "status": "SUCCESS"
              }
            ]
          }
        ],
        "success_steps": 5,
        "total_steps": 5
      },
      "spec": {
        "ingress": {
          "rules": [
            {
              "component": {
                "name": "my-app"
              },
              "match": {
                "path": {
                  "prefix": "/"
                }
              }
            }
          ]
        },
        "name": "my-app",
        "region": "blr",
        "static_sites": [
          {
            "github": {
              "branch": "main",
              "deploy_on_push": true,
              "repo": "digitalocean/hello-world"
            },
            "name": "my-app"
          }
        ]
      },
      "static_sites": [
        {
          "name": "my-app",
          "source_commit_hash": "8ac84464242f1b430147319deb28abb5a20049b8"
        }
      ],
      "updated_at": "2026-03-24T10:19:07Z"
    },
    "created_at": "2026-03-24T10:17:51Z",
    "default_ingress": "https://my-app-ixj6x.ondigitalocean.app",
    "id": "eb0fc7fa-8294-48c5-8a48-77d47fc6c89e",
    "last_deployment_created_at": "2026-03-24T10:17:51Z",
    "live_domain": "my-app-ixj6x.ondigitalocean.app",
    "live_url": "https://my-app-ixj6x.ondigitalocean.app",
    "live_url_base": "https://my-app-ixj6x.ondigitalocean.app",
    "pending_deployment": {
      "id": ""
    },
    "region": {
      "continent": "Asia",
      "data_centers": [
        "blr1"
      ],
      "flag": "india",
      "label": "Bangalore",
      "slug": "blr"
    },
    "spec": {
      "ingress": {
        "rules": [
          {
            "component": {
              "name": "my-app"
            },
            "match": {
              "path": {
                "prefix": "/"
              }
            }
          }
        ]
      },
      "name": "my-app",
      "region": "blr",
      "static_sites": [
        {
          "github": {
            "branch": "main",
            "deploy_on_push": true,
            "repo": "digitalocean/hello-world"
          },
          "name": "my-app"
        }
      ]
    },
    "updated_at": "2026-03-24T10:19:13Z"
  },
  "timestamp": "2026-03-26T08:21:30.077395918Z",
  "type": "digitalocean.app.fetched"
}
```

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

### Dash0 Synthetic Check Configuration

Source: https://docs.superplane.com/components/dash0

Example of a Dash0 synthetic check configuration for an HTTP GET request. It includes assertions for status code and timing, along with scheduling and retry settings.

```json
{
  "data": {
    "configuration": {
      "kind": "Dash0SyntheticCheck",
      "metadata": {
        "annotations": {},
        "description": "",
        "labels": {
          "dash0.com/dataset": "default",
          "dash0.com/id": "64617368-3073-796e-7468-73599f287bf4",
          "dash0.com/origin": "",
          "dash0.com/version": "21"
        },
        "name": "New synthetic check"
      },
      "spec": {
        "display": {
          "name": "New synthetic check"
        },
        "enabled": true,
        "labels": {},
        "notifications": {
          "channels": [],
          "onlyCriticalChannels": []
        },
        "plugin": {
          "kind": "http",
          "spec": {
            "assertions": {
              "criticalAssertions": [
                {
                  "kind": "status_code",
                  "spec": {
                    "operator": "is",
                    "value": "200"
                  }
                }
              ],
              "degradedAssertions": [
                {
                  "kind": "timing",
                  "spec": {
                    "operator": "lte",
                    "type": "total",
                    "value": "2000ms"
                  }
                }
              ]
            },
            "request": {
              "headers": [],
              "method": "get",
              "queryParameters": [],
              "redirects": "follow",
              "tls": {
                "allowInsecure": false
              },
              "tracing": {
                "addTracingHeaders": true
              },
              "url": "https://example.com/health"
            }
          }
        },
        "retries": {
          "kind": "off",
          "spec": {}
        },
        "schedule": {
          "interval": "1m",
          "locations": [
            "be-brussels"
          ],
          "strategy": "all_locations"
        }
      }
    },
    "metrics": {
      "avgDuration24hMs": 1004,
      "avgDuration7dMs": 1004,
      "criticalRuns24h": 2275,
      "criticalRuns7d": 2438,
      "healthyRuns24h": 6,
      "healthyRuns7d": 37,
      "lastOutcome": "Healthy",
      "totalRuns24h": 2281,
      "totalRuns7d": 2475
    }
  },
  "timestamp": "2026-03-03T11:00:00Z",
  "type": "dash0.syntheticCheck.fetched"
}
```

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

### Example Droplet Metrics Output

Source: https://docs.superplane.com/components/digitalocean

This JSON shows the averaged CPU, memory, and bandwidth metrics for a droplet over a specified period. Ensure the DigitalOcean Monitoring Agent is installed on the droplet for this data to be available.

```json
{
  "data": {
    "avgCpuUsagePercent": 0.18,
    "avgMemoryUsagePercent": 34.39,
    "avgPublicInboundBandwidthMbps": 0.36,
    "avgPublicOutboundBandwidthMbps": 0.15,
    "dropletId": "559378149",
    "end": "2026-03-19T08:36:34Z",
    "lookbackPeriod": "1h",
    "start": "2026-03-19T07:36:34Z"
  },
  "timestamp": "2026-03-19T08:36:37.115389929Z",
  "type": "digitalocean.droplet.metrics"
}
```

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

### AWS SQS Get Queue Example Output

Source: https://docs.superplane.com/components/aws

This JSON output retrieves metadata and attributes for an AWS SQS queue, including its ARN and various configuration parameters like VisibilityTimeout and MessageRetentionPeriod.

```json
{
  "data": {
    "attributes": {
      "DelaySeconds": "0",
      "MaximumMessageSize": "262144",
      "MessageRetentionPeriod": "345600",
      "QueueArn": "arn:aws:sqs:us-east-1:123456789012:my-queue",
      "ReceiveMessageWaitTimeSeconds": "0",
      "VisibilityTimeout": "30"
    },
    "queueUrl": "https://sqs.us-east-1.amazonaws.com/123456789012/my-queue"
  },
  "timestamp": "2026-02-11T12:00:00Z",
  "type": "aws.sqs.queue"
}
```

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

### Example Pub/Sub Topic Creation Output

Source: https://docs.superplane.com/components/googlecloud

This JSON confirms the creation of a Google Cloud Pub/Sub topic, including its project and topic name.

```json
{
  "data": {
    "name": "projects/my-project/topics/my-topic",
    "topic": "my-topic"
  },
  "timestamp": "2025-01-01T00:00:00Z",
  "type": "gcp.pubsub.topic"
}
```

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

### Create Sandbox Output

Source: https://docs.superplane.com/components/daytona

Example JSON response returned after initializing a new isolated sandbox environment.

```json
{
  "data": {
    "id": "sandbox-abc123def456",
    "state": "started"
  },
  "timestamp": "2026-01-19T12:00:00Z",
  "type": "daytona.sandbox"
}
```

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

### If Component: Example Output

Source: https://docs.superplane.com/components/core

Example JSON output after an If component execution.

```json
{
  "data": {},
  "timestamp": "2026-01-16T17:56:16.680755501Z",
  "type": "if.executed"
}
```

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

### Example Compute Engine VM Creation Output

Source: https://docs.superplane.com/components/googlecloud

This JSON details the successful creation of a Google Compute Engine virtual machine, including its network and instance properties.

```json
{
  "data": {
    "externalIP": "34.1.2.3",
    "instanceId": "1234567890123456789",
    "internalIP": "10.0.0.2",
    "machineType": "e2-medium",
    "name": "my-vm",
    "selfLink": "https://www.googleapis.com/compute/v1/projects/my-project/zones/us-central1-a/instances/my-vm",
    "status": "RUNNING",
    "zone": "us-central1-a"
  },
  "timestamp": "2025-02-14T12:00:00Z",
  "type": "gcp.createVM.completed"
}
```

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

### Example Incident Event Data

Source: https://docs.superplane.com/components/rootly

This JSON object represents an example of an incident event within Rootly.

```json
{
  "data": {
    "created_at": "2026-02-22T09:46:23.868-08:00",
    "event": "Investigation started, will update accordingly",
    "event_id": "b3065ca8-69a6-4781-b6b4-94d6f0317ccf",
    "event_raw": "Investigation started, will update accordingly",
    "event_type": "incident_event.created",
    "id": "56f7b488-e3c5-4091-9bb4-cf132007f98c",
    "incident": {
      "id": "64c39fde-1626-4f78-874e-9db91c0639d3",
      "services": [
        "UI - User Profile Block"
      ],
      "severity": "sev2",
      "status": "mitigated",
      "teams": [
        "Customer Relations"
      ],
      "title": "new remake from main"
    },
    "incident_id": "64c39fde-1626-4f78-874e-9db91c0639d3",
    "issued_at": "2026-02-22T09:46:24.018-08:00",
    "kind": "event",
    "occurred_at": "2026-02-22T09:46:23.868-08:00",
    "source": "web",
    "updated_at": "2026-02-22T09:46:23.868-08:00",
    "visibility": "internal"
  },
  "timestamp": "2026-02-22T17:46:40.603539728Z",
  "type": "rootly.onIncidentTimelineEvent"
}
```

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

### Run SuperPlane Demo Container

Source: https://docs.superplane.com/

Use this command to quickly start a demo instance of SuperPlane locally for exploration. It pulls the latest stable demo image and maps port 3000.

```bash
docker pull ghcr.io/superplanehq/superplane-demo:stable
```

```bash
docker run --rm -p 3000:3000 -v spdata:/app/data -ti ghcr.io/superplanehq/superplane-demo:stable
```

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

### Merge Component: Example Output

Source: https://docs.superplane.com/components/core

Example JSON output after a Merge component has successfully combined inputs.

```json
{
  "data": {
    "eventIDs": [
      "event_1",
      "event_2"
    ],
    "groupKey": "merge-group-123",
    "sources": [
      "node_a",
      "node_b"
    ],
    "stopEarly": false
  },
  "timestamp": "2026-01-16T17:56:16.680755501Z",
  "type": "merge.finished"
}
```

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

### Clone and Configure Terraform

Source: https://docs.superplane.com/installation/kubernetes/amazon-eks

Prepares the Terraform environment for deployment.

```bash
git clone https://github.com/superplanehq/superplane-terraform
```

```bash
cd superplane-terraform/eks
cp terraform.tfvars.example terraform.tfvars
```

```hcl
domain_name       = "superplane.example.com"
letsencrypt_email = "admin@example.com"
```

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

### Webhook Example Data

Source: https://docs.superplane.com/components/core

Example JSON payload structure received by a workflow via a webhook trigger.

```json
{
  "data": {
    "body": {
      "event": "push",
      "repository": "superplanehq/superplane"
    },
    "headers": {
      "X-Event": [
        "push"
      ]
    }
  },
  "timestamp": "2026-01-19T12:00:00Z",
  "type": "webhook"
}
```

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

### Redirect Rule Example Output

Source: https://docs.superplane.com/components/cloudflare

Example JSON response structure for an updated Cloudflare redirect rule.

```json
{
  "data": {
    "enabled": true,
    "rule": {
      "action": "redirect",
      "action_parameters": {
        "from_value": {
          "preserve_query_string": false,
          "status_code": 301,
          "target_url": {
            "value": "https://example.com/new-path"
          }
        }
      },
      "description": "Redirect old path to new path",
      "enabled": true,
      "expression": "http.request.uri.path eq \"/old-path\"",
      "id": "rule_abc123"
    },
    "ruleId": "rule_abc123",
    "zoneId": "zone_xyz789"
  },
  "timestamp": "2026-03-26T19:29:35.841265352Z",
  "type": "cloudflare.redirectRule"
}
```

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

### Retrieve GitHub Release Information

Source: https://docs.superplane.com/components/github

Example JSON response containing release metadata, assets, and author details.

```json
{
  "data": {
    "assets": [
      {
        "browser_download_url": "https://github.com/acme/widgets/releases/download/v1.2.3/app-v1.2.3.zip",
        "content_type": "application/zip",
        "download_count": 42,
        "id": 1,
        "label": "Application Bundle",
        "name": "app-v1.2.3.zip",
        "size": 1024000
      }
    ],
    "author": {
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "html_url": "https://github.com/octocat",
      "id": 1,
      "login": "octocat"
    },
    "body": "## What's Changed\n\n- Feature A\n- Bug fix B",
    "created_at": "2026-01-15T10:00:00Z",
    "draft": false,
    "html_url": "https://github.com/acme/widgets/releases/tag/v1.2.3",
    "id": 3001,
    "name": "Release 1.2.3",
    "prerelease": false,
    "published_at": "2026-01-16T12:00:00Z",
    "tag_name": "v1.2.3"
  },
  "timestamp": "2026-01-16T17:56:16.680755501Z",
  "type": "github.release"
}
```

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

### List Canvases with Different Output Formats

Source: https://docs.superplane.com/installation/cli

Demonstrates listing canvases using different output formats: text (default), JSON, and YAML. Use the -o or --output flag.

```bash
superplane canvases list --output text
```

```bash
superplane canvases list -o json
```

```bash
superplane canvases get <canvas_name_or_id> -o yaml
```

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

### DNS Record Example Output

Source: https://docs.superplane.com/components/cloudflare

Example JSON response structure for a Cloudflare DNS record operation.

```json
{
  "data": {
    "record": {
      "content": "203.0.113.10",
      "id": "record_abc123",
      "name": "app.example.com",
      "proxied": true,
      "ttl": 1,
      "type": "A"
    },
    "recordId": "record_abc123",
    "zoneId": "zone_xyz789"
  },
  "timestamp": "2026-03-26T19:29:35.841265352Z",
  "type": "cloudflare.dnsRecord"
}
```

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

### GET Cloud Build • Get Build

Source: https://docs.superplane.com/components/googlecloud

Retrieves the details of a specific Google Cloud Build build.

```APIDOC
## GET Cloud Build • Get Build

### Description
Retrieves the details of a specific Google Cloud Build build.

### Parameters
#### Request Body
- **Build ID** (string) - Required - The ID or full resource name of the Cloud Build build to retrieve.
- **Project ID Override** (string) - Optional - Override the GCP project ID from the integration.

### Response
#### Success Response (200)
- **data** (object) - The full Build resource, including id, status, logUrl, steps, images, createTime, finishTime, and more.

#### Response Example
{
  "data": {
    "createTime": "2025-01-01T00:00:00Z",
    "finishTime": "2025-01-01T00:05:00Z",
    "id": "12345678-abcd-1234-5678-abcdef012345",
    "logUrl": "https://console.cloud.google.com/cloud-build/builds/12345678-abcd-1234-5678-abcdef012345",
    "projectId": "my-project",
    "status": "SUCCESS"
  },
  "timestamp": "2025-01-01T00:05:00Z",
  "type": "gcp.cloudbuild.build"
}
```

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

### Cloud Build Example Output

Source: https://docs.superplane.com/components/googlecloud

Represents the JSON structure returned after a Cloud Build operation, containing build metadata and status.

```json
{
  "data": {
    "createTime": "2025-01-01T00:00:00Z",
    "finishTime": "2025-01-01T00:05:00Z",
    "id": "12345678-abcd-1234-5678-abcdef012345",
    "logUrl": "https://console.cloud.google.com/cloud-build/builds/12345678-abcd-1234-5678-abcdef012345",
    "projectId": "my-project",
    "status": "SUCCESS"
  },
  "timestamp": "2025-01-01T00:05:00Z",
  "type": "gcp.cloudbuild.build"
}
```

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

### SQS Send Message Example Output

Source: https://docs.superplane.com/components/aws

This is an example of the output generated after successfully publishing a message to an AWS SQS queue.

```json
{
  "data": {
    "messageId": "d84c1b4d-1f3b-4b6c-9d9f-5c3a2b1f9e7a",
    "queueUrl": "https://sqs.us-east-1.amazonaws.com/123456789012/my-queue"
  },
  "timestamp": "2026-02-11T12:00:00Z",
  "type": "aws.sqs.message"
}
```

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

### Create Repository Sandbox API

Source: https://docs.superplane.com/components/daytona

Creates a new Daytona sandbox, clones a repository, and runs a bootstrap script. The component waits for the sandbox to reach the 'started' state.

```APIDOC
## Create Repository Sandbox

### Description
Creates a new Daytona sandbox, clones a repository, and runs a bootstrap script.

### Use Cases
- Ephemeral dev environments
- CI-like workflows
- Automated validation

### Notes
- The component waits for the sandbox to reach the “started” state
- Clone and bootstrap run sequentially in the same session
- If clone or bootstrap fails, the component returns an error

### Example Output
```json
{
  "data": {
    "bootstrap": {
      "from": "file",
      "path": "scripts/bootstrap.sh"
    },
    "directory": "/home/daytona/example-app",
    "repository": "https://github.com/superplanehq/example-app.git",
    "sandboxId": "sandbox-abc123def456",
    "sandboxStartedAt": "2026-01-19T12:00:00Z",
    "secrets": [
      {
        "name": "API_KEY",
        "type": "env",
        "value": {
          "key": "API_KEY",
          "secret": "api-key-secret"
        }
      }
    ],
    "timeout": 300
  },
  "timestamp": "2026-01-19T12:00:00Z",
  "type": "daytona.repository.sandbox"
}
```
```

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

### Example Pub/Sub Subscription Creation Output

Source: https://docs.superplane.com/components/googlecloud

This JSON confirms the creation of a Google Cloud Pub/Sub subscription, specifying its name, topic, and type (pull or push).

```json
{
  "data": {
    "name": "projects/my-project/subscriptions/my-subscription",
    "subscription": "my-subscription",
    "topic": "my-topic",
    "type": "pull"
  },
  "timestamp": "2025-01-01T00:00:00Z",
  "type": "gcp.pubsub.subscription"
}
```