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

Rely.io Automations API

Manage automation rules that trigger workflows based on catalog entity changes or external events via plugin integrations.

Rely.io Automations API is one of 6 APIs that Rely.io publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Automations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.

This API exposes 2 operations across 1 path, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.rely.io.

2 operations 1 paths 3 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.rely.io
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Rely.io Automations API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Long-lived API key generated in the Rely.io Plugins settings page. Valid for 10 years. Include as Bearer token in Authorization header.

Paths & Operations 2

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

Automations 2

Manage automation rules that trigger workflows based on catalog entity changes or external events via plugin integrations.

GET
/api/v1/automations
List Automations
listAutomations → 200401
POST
/api/v1/automations
Create Automation
createAutomation body → 201400401

Schemas 3

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

AutomationRequest
object
5 properties 3 required
Error
object
2 properties
Automation
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rely-automations-api-openapi.yml Raw ↑

Other APIs Rely.io publishes across the network.

Rely.io Blueprints API
Rely.io Entities API
Rely.io Scorecards API
Rely.io Self-Service Actions API
Rely.io Users API