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

Manage blueprint schemas that define the structure and attributes of catalog entities such as services, teams, and resources.

Rely.io Blueprints 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 Blueprints. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.

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

5 operations 2 paths 5 schemas 1 DELETE2 GET1 POST1 PUT

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 Blueprints 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 5

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

Blueprints 5

Manage blueprint schemas that define the structure and attributes of catalog entities such as services, teams, and resources.

GET
/api/v1/blueprints
List Blueprints
listBlueprints → 200401
POST
/api/v1/blueprints
Create Blueprint
createBlueprint body → 201400401
GET
/api/v1/blueprints/{blueprintId}
Get Blueprint
getBlueprint 1 param → 200401404
PUT
/api/v1/blueprints/{blueprintId}
Update Blueprint
updateBlueprint 1 param body → 200400401404
DELETE
/api/v1/blueprints/{blueprintId}
Delete Blueprint
deleteBlueprint 1 param → 204401404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Blueprint (7 properties), BlueprintProperty (5 properties), BlueprintRequest (5 properties), BlueprintRelation (4 properties). Each schema is shown below with its type and property counts.

BlueprintRequest
object
5 properties 2 required
BlueprintRelation
object
4 properties
Error
object
2 properties
BlueprintProperty
object
5 properties
Blueprint
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rely-blueprints-api-openapi.yml Raw ↑

Other APIs Rely.io publishes across the network.

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