Rely.io
Search
K

Overview

Authentication

Users can create access keys for the API via the Settings page.
These keys serve as credentials for authenticating access to Rely's REST API. To authenticate, include the key in the 'Authorization' header of the API request, formatted as "Bearer {your_token_here}".

Token Expiration and Limitations

Tokens created via this process are valid for a duration of 10 years.
However, users are limited to one active token at any given time. Generating a new token will automatically deactivate any previously issued token.
If you feel the need to have more than one token valid at each time, feel free to reach out to [email protected].

Endpoints

get
/api/v1/health
Perform a Health Check
get
/api/v1/blueprints
Get Blueprints
post
/api/v1/blueprints
Create Blueprint
put
/api/v1/blueprints
Create Or Update Blueprint
put
/api/v1/blueprints/bulk
Create Or Update Blueprints Bulk
get
/api/v1/blueprints/{id_}
Get Blueprint
put
/api/v1/blueprints/{id_}
Update Blueprint
delete
/api/v1/blueprints/{id_}
Delete Blueprint
get
/api/v1/blueprints/{id_}/schemaProperties
Get Blueprint Schema Properties
post
/api/v1/blueprints/{id_}/schemaProperties
Create Blueprint Schema Properties
put
/api/v1/blueprints/{id_}/schemaProperties
Update Blueprint Schema Properties
delete
/api/v1/blueprints/{id_}/schemaProperties/{schema_property_key}
Delete Blueprint Schema Properties
get
/api/v1/blueprints/{id_}/relations
Get Blueprint Relations
post
/api/v1/blueprints/{id_}/relations
Create Blueprint Relations
put
/api/v1/blueprints/{id_}/relations
Update Blueprint Relations
delete
/api/v1/blueprints/{id_}/relations/{relation_key}
Delete Blueprint Relations
get
/api/v1/blueprints/{id_}/referenceProperties
Get Blueprint Reference Properties
post
/api/v1/blueprints/{id_}/referenceProperties
Create Blueprint Reference Properties
put
/api/v1/blueprints/{id_}/referenceProperties
Update Blueprint Reference Properties
delete
/api/v1/blueprints/{id_}/referenceProperties/{ref_property_key}
Delete Blueprint Reference Properties
get
/api/v1/entities
Get Entities
post
/api/v1/entities
Create Entity
get
/api/v1/entities/{id_}
Get Entity
put
/api/v1/entities/{id_}
Upsert Entity
delete
/api/v1/entities/{id_}
Delete Entity
put
/api/v1/entities/bulk
Create Or Update Entities Bulk
post
/api/v1/entities/validate
Validate Entity
get
/api/v1/entities/{id_}/relations
Get Relations
Last modified 1mo ago