Rely.io
  • πŸ“ŒWhat is Rely.io?
  • πŸ’‘How Rely.io works
  • πŸ“‘Getting Started Guide
    • Create an account for your organization
    • Add your first plugin
    • Import services into the Service Catalog
    • Make the Software Catalog your own
    • What's Next?
  • 🌈Basic Concepts
    • Entities
    • Blueprints
    • Property Data Types
    • Catalogs
    • Data Model
    • Plugins
    • User Blueprints vs Plugin Blueprints
    • Actions and Automations
      • Automation Rules
      • Self-Service Actions
    • Home Pages
    • Scorecards
  • πŸ“šGuides & Tutorials
    • Enhancing Deployment Visibility through Gitlab Pipelines and Rely's API
  • πŸ–₯️Software Catalog
    • Overview and Use Cases
    • Usage Guide
      • Creating a new Entity
      • Updating an Entity
      • Tracking Entity Changes
      • Customizing an Entity's Page
      • Customizing a Catalog
      • Creating a new Blueprint & Catalog
      • Updating a Blueprint
      • Tracking Blueprint Changes
    • Relevant Guides
    • Troubleshooting
  • πŸ₯‡Scorecards
    • Overview and Use Cases
    • Usage Guide
      • Creating a Scorecard
      • Updating a Scorecard
      • Evaluating Performance
    • Scorecard Examples
      • Production Readiness Scorecard Example
      • DORA Metrics Scorecard Example
      • Operational Maturity Example
  • 🎨Home Pages
    • Overview and Use Cases
    • Usage Guide
      • Creating a New Tab
  • ⚑Self-Service Actions
    • Overview and Use Cases
    • Usage Guide
      • Configuring your Self Service Agent
      • Managing your Actions Catalog
      • Self-Service Actions as Code
      • Running Actions
      • Tracking Action Runs
  • ↗️Plugins & Automation
    • What happens when you install a Plugin?
    • Self-Hosting Plugins using Galaxy
    • πŸ€–Automation Rules
      • Overview and Use Cases
      • Usage Guide
        • Creating an Automation Rule
        • Updating an Automation Rule
        • Tracking Automation Changes
        • Managing Automation Suggestion
    • πŸ”ŒPlugin Installation Guides
      • ⭐AWS
      • Bitbucket
      • ⭐Flux
      • GitHub
      • GitLab
      • ⭐Google Cloud Platform (GCP)
      • ⭐Kubernetes
      • ⭐OpsGenie
      • ⭐PagerDuty
      • ⭐Snyk
      • ⭐SonarQube
  • 🌐Public API
    • Audit Logs
    • Automations & Self-Service Actions
    • Automation Suggestions
    • Blueprints
    • Dashboards & Views
    • Entities
    • Scorecards
    • Self-Service Action Runs
    • Time Series
    • Users
    • Webhooks
  • βš™οΈInvite Users
  • πŸ›‘οΈSecurity & Compliance
    • Single Sign-On (SSO)
      • SAML with Google Workspace
      • SAML with Microsoft Entra ID
      • SAML with Okta
      • OIDC with Okta
      • OIDC with Google Workspace
  • πŸ₯Troubleshooting
  • ❓FAQ
Powered by GitBook
On this page
  • Authentication
  • Examples
  • Troubleshooting

Was this helpful?

Public API

PreviousSonarQubeNextAudit Logs

Last updated 7 months ago

Was this helpful?

The REST API offers programmatic access to various features, including catalog data, self-service actions, automations, and scorecards.

Authentication

To use the REST API, users must first generate an API key. Without this key, all access to the REST API will be denied. Users can create API access keys on the Plugins page.

Once on the Plugins page, select View Details for the Public API plugin and you will be able to generate an API key.

Tokens created via this process are valid for a duration of 10 years.

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 support@rely.io.

These keys act as credentials for authenticating access to Rely's REST API. To authenticate, include the key in the Authorization header of your API request. Format it as Bearer {your_token_here}, as shown in the example below.

const response = await fetch('/api/v1/legacy/users/invite', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer YOUR_TOKEN_HERE",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "John Doe",
      "email": "john.doe@rely.io"
    }),
});
const data = await response.json();

Examples

Troubleshooting

If you encounter any issues that you're unable to resolve on your own, please don't hesitate to contact our support team at support@rely.io.

To see a functional example for interacting with Rely's public API checkout our guide for "".

Additionally, if you would like to discuss a specific use-case you're targeting, feel free to to brainstorm and gain further insights.

🌐
Enhancing Deployment Visibility through GitLab Pipelines and Rely.io’s Public API
book a session with one of our experts
public api in plugins page
generate api key