Skip to main content
The Pelanor API enables several key use cases:

Internal System Integration

Connect CRM, ERP, and other enterprise software to synchronize Pelanor dimensions and segments with your business-contextual data.

Data Enrichment

Enhance Pelanor cloud-cost data with metrics from observability platforms, or import custom cost data.

Reporting & Data Export

Build custom data pipelines to export Pelanor cloud-cost data into external systems for advanced reporting.

​
Attributes

Many endpoints in the Pelanor API accept filters that reference Attribute IDs. Attributes fall into two main categories:

Properties

Metadata collected by Pelanor from billing data exports, service integrations, and agents. Properties also include Custom Dimensions. Examples include: Region, CloudServiceProvider, Instance Type.

Metrics

Analytics collected from various integrations, including Custom Metrics. These provide measurement and performance insights beyond raw billing data. Examples: CPU Utilization, Average Daily Pods, GPU Hours.
To find the valid ID for a property or metric, use the List Attributes endpoint.
This returns all available attributes along with their display names (as shown in the UI) and short descriptions.

​
Authentication

All API endpoints require HTTP Bearer authentication. Tokens are managed through the Pelanor platform; you’ll need to log in with an Administrator account to create a new token.
1

Log in to Pelanor

Log in to your Pelanor environment with an admin-level account.
2

Open the API Tokens page

Go to Settings → API Tokens.
3

Generate a new token

Give the token a descriptive name (e.g., integration or project).
Select the least-privilege role that still covers the endpoints you need.
For details, see the Roles & Permissions reference.
4

Store the token securely

After clicking Generate Token, you will receive a Token ID and Token Secret.
Copy them immediately and store them securely—the secret is shown only once.
5

Add the Authorization header

Sign every request with the following header:Authorization: Bearer <Token ID>:<Token Secret>

​
Basic Request Example

export PELANOR_API_TOKEN="aa11bb22cc33dd44:ee55ff66gg77hh88"

curl -X GET https://api.pelanor.io/v2/dimensions \
  -H "Authorization: Bearer $PELANOR_API_TOKEN" \
  -H "Content-Type: application/json"
⌘I