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 Automation API

Create and manage automations that trigger replicas on a schedule or in response to events

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

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

This API exposes 8 operations across 5 paths, and defines 18 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.

8 operations 5 paths 18 schemas 1 DELETE3 GET1 PATCH3 POST

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 Automation 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 8

Across 5 paths, the API surfaces 8 operations — 1 DELETE, 3 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Automation 8

Create and manage automations that trigger replicas on a schedule or in response to events

GET
/v1/automations
List Automations
listAutomations 6 params → 200400401500
POST
/v1/automations
Create Automation
createAutomation body → 201400401403500
GET
/v1/automations/{id}
Get Automation
getAutomation 1 param → 200401404500
PATCH
/v1/automations/{id}
Update Automation
updateAutomation 1 param body → 200400401404500
DELETE
/v1/automations/{id}
Delete Automation
deleteAutomation 1 param → 200401404500
POST
/v1/automations/{id}/trigger
Trigger Automation
triggerAutomation 1 param body → 200400401404500
GET
/v1/automations/{id}/executions
List Automation Executions
listAutomationExecutions 3 params → 200401404500
POST
/v1/automations/webhook/{token}
Fire a Custom Webhook Automation
fireCustomWebhookAutomation 1 param body → 202404413500

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are AutomationRecord (27 properties), CreateAutomationRequest (18 properties), UpdateAutomationRequest (17 properties), AutomationExecutionRecord (10 properties). Each schema is shown below with its type and property counts.

WorkspaceConfig
object
Workspace behavior configuration. Missing capabilities and preferences default to disabled.
3 properties
GitLabTriggerConfig
object
Configuration for a GitLab merge request event trigger
4 properties 1 required
Error
object
2 properties 1 required
CustomTriggerConfig
object
Configuration for a custom webhook trigger. The config is intentionally empty: the automation's generated webhooktoken is the only thing that needs to be store…
UpdateAutomationRequest
object
Request body for updating an automation. Only provided fields are updated.
17 properties
AutomationResponse
object
Response containing a single automation
1 property 1 required
ListAutomationsResponse
object
Paginated list of automations
5 properties 5 required
SentryTriggerConfig
object
Configuration for a Sentry event trigger
3 properties 1 required
ListAutomationExecutionsResponse
object
Paginated list of automation executions
5 properties 5 required
AutomationExecutionRecord
object
A record of a single automation execution
10 properties 10 required
SlackTriggerConfig
object
Configuration for a Slack event trigger
3 properties 1 required
CronTriggerConfig
object
Configuration for a cron (scheduled) trigger
2 properties 1 required
AutomationRecord
object
An automation record
27 properties 27 required
CreateAutomationRequest
object
Request body for creating a new automation. The automation runs in a single environment specified by environmentid.
18 properties 4 required
GitHubTriggerConfig
object
Configuration for a GitHub event trigger
4 properties 1 required
AutomationTrigger
object
A trigger that determines when an automation fires
2 properties 2 required
TriggerAutomationResponse
object
Response after triggering an automation
2 properties 2 required
TriggerAutomationRequest
object
Request body for manually triggering an automation
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

replicas-automation-api-openapi.yml Raw ↑

Other APIs Replicas publishes across the network.

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