> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.itential.com/adapters/configure/endpoint-configuration/overview/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.itential.com/_mcp/server.

# Endpoint configuration overview

> Define API actions and data schemas for adapter endpoints.

Endpoint configuration defines how adapters communicate with external APIs. Configure API endpoints in action.json and data structures in schema.json.

## What is endpoint configuration

Endpoint configuration consists of two components that work together:

**Actions** (`action.json`) - Define API operations

* Which endpoints to call
* How to construct requests
* How to handle responses

**Schemas** (`schema.json`) - Define data structures

* Validate request data
* Transform field names
* Parse response data

## How actions and schemas work together

#### Adapter receives request

Platform workflow calls adapter method with data

#### Schema validates request

Schema checks data is valid before sending

#### Action constructs API call

Action builds URL, headers, and request body

#### API returns response

External system sends response data

#### Schema processes response

Schema parses, translates, and validates response

#### Platform receives data

Workflow receives formatted, validated data

## File structure

Endpoint configuration files are organized by entity:

```
entities/
  Users/
    action.json          # API operations for users
    schema.json          # Data structures for users
  Devices/
    action.json          # API operations for devices
    schema.json          # Data structures for devices
```

**Entity** - Logical grouping of related API endpoints (Users, Devices, Tickets, etc.)

## Configuration workflow

#### Review API documentation

Identify available endpoints, required parameters, data formats

#### Configure actions

Define API endpoints in action.json files

[Learn about actions →](../actions/overview)

#### Configure schemas

Define data validation and transformation in schema.json files

[Learn about schemas →](../schemas/overview)

#### Test configuration

Verify actions connect to API correctly

[Learn about testing →](/adapters/test/test-and-lint-adapters)

## When to configure endpoints

### Configure actions when you need to:

* Call external API endpoints
* Add new operations to existing adapters
* Modify how requests are constructed
* Change timeouts or headers

### Configure schemas when you need to:

* Validate data before sending to APIs
* Translate field names between systems
* Parse or transform response data
* Secure sensitive fields

## Generated vs manual configuration

### Adapter Builder (generated)

Adapter Builder can generate configuration from OpenAPI specifications:

* Creates actions for all endpoints
* Generates schemas from API documentation

**Best for:** New adapters, standardized APIs, rapid prototyping

### Manual configuration

Create or modify configuration files directly:

* Add custom transformations
* Handle non-standard APIs
* Optimize for specific use cases

**Best for:** Custom integrations, API gaps, specialized requirements

## What's next

#### [Actions overview](/adapters/configure/actions/overview)

Understand how actions define API operations

#### [Schemas overview](/adapters/configure/schemas/overview)

Understand how schemas validate and transform data

#### [Configure actions](/adapters/configure/actions/reference)

Create action.json files

#### [Configure schemas](/adapters/configure/schemas/overview)

Create schema.json files

> Define API actions and data schemas for adapter endpoints.