Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Replicas Preview API

Manage public preview URLs for workspace ports

Replicas Preview API is one of 13 APIs that Replicas publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Preview. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 2 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://api.tryreplicas.com.

2 operations 2 paths 2 schemas 2 DELETE

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.tryreplicas.com
Authentication
HTTP Bearer, HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 3

Replicas Preview API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (apiKey). It accepts HTTP bearer tokens (engineSecret). An API key is passed in the header as X-Workspace-Id (workspaceId). By default, every request must be authenticated.

  • apiKey — API key authentication. Obtain your API key from the Replicas dashboard under Organization → Settings → API Keys.
  • engineSecret — Workspace engine secret used by agent-mode workspace requests.
  • workspaceId — Workspace ID used with the engine secret for agent-mode workspace requests.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 DELETE. Each is listed below with its method, path, parameters, and response codes.

Preview 2

Manage public preview URLs for workspace ports

DELETE
/v1/previews/{port}
Delete Preview
deleteAgentPreview 1 param → 200400401404500
DELETE
/v1/workspaces/{workspaceId}/previews/{port}
Delete Workspace Preview
deleteWorkspacePreview 2 params → 200400401404500

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are DeletePreviewResponse (2 properties), Error (2 properties). Each schema is shown below with its type and property counts.

Error
object
2 properties 1 required
DeletePreviewResponse
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

replicas-preview-api-openapi.yml Raw ↑

Other APIs Replicas publishes across the network.

Replicas Analytics API
Replicas API Keys API
Replicas Automation API
Replicas Credentials API
Replicas Downloads API
Replicas Environments API
Replicas Google Search Console API
Replicas Profile API
Replicas Replica API
Replicas Repository API
Replicas Slack API
Replicas Terminal API