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

Manage catalog entity instances — the individual services, teams, deployments, and resources tracked in the software catalog.

Rely.io Entities 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 Entities. 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 4 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 4 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 Entities 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.

Entities 5

Manage catalog entity instances — the individual services, teams, deployments, and resources tracked in the software catalog.

GET
/api/v1/blueprints/{blueprintId}/entities
List Entities
listEntities 3 params → 200401
POST
/api/v1/blueprints/{blueprintId}/entities
Create Entity
createEntity 1 param body → 201400401
GET
/api/v1/blueprints/{blueprintId}/entities/{entityId}
Get Entity
getEntity 2 params → 200401404
PUT
/api/v1/blueprints/{blueprintId}/entities/{entityId}
Update Entity
updateEntity 2 params body → 200400401404
DELETE
/api/v1/blueprints/{blueprintId}/entities/{entityId}
Delete Entity
deleteEntity 2 params → 204401404

Schemas 4

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

Entity
object
7 properties
Error
object
2 properties
EntityRequest
object
4 properties 2 required
Pagination
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rely-entities-api-openapi.yml Raw ↑

Other APIs Rely.io publishes across the network.

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