> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pelanor.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Getting Started

> Learn how to connect and authenticate with the Pelanor API

The Pelanor API enables several key use cases:

<Columns cols={3}>
  <Card icon="cloud-arrow-up" title="Internal System Integration">
    Connect CRM, ERP, and other enterprise software to synchronize Pelanor dimensions and segments with your business-contextual data.
  </Card>

  <Card icon="pickaxe" title="Data Enrichment">
    Enhance Pelanor cloud-cost data with metrics from observability platforms, or import custom cost data.
  </Card>

  <Card icon="file-chart-column" title="Reporting & Data Export">
    Build custom data pipelines to export Pelanor cloud-cost data into external systems for advanced reporting.
  </Card>
</Columns>

***

## Attributes

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

<Columns cols={2}>
  <Card icon="table-columns" title="Properties">
    Metadata collected by Pelanor from billing data exports, service integrations, and agents. Properties also include **Custom Dimensions**.
    Examples include: `Region`, `CloudServiceProvider`, `Instance Type`.
  </Card>

  <Card icon="chart-line" title="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`.
  </Card>
</Columns>

To find the valid ID for a property or metric, use the [List Attributes](/v2/schema/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.

<Steps>
  <Step title="Log in to Pelanor">
    Log in to your Pelanor environment with an admin-level account.
  </Step>

  <Step title="Open the API Tokens page">
    Go to **Settings → API Tokens**.
  </Step>

  <Step title="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](/settings/roles-and-permissions) reference.
  </Step>

  <Step title="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**.
  </Step>

  <Step title="Add the Authorization header">
    Sign every request with the following header:

    `Authorization: Bearer <Token ID>:<Token Secret>`
  </Step>
</Steps>

***

## Basic Request Example

```bash theme={null}
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"
```